Resources for Developers

APIs for Search.gov Customers

These APIs are available for use on official government websites only. You must be a Search.gov customer with an active user account.

Search Results API — This API exposes all relevant results “modules” in a single JSON call, including: web results, best bets, health topics, job openings, recent news, recent videos, Federal Register documents, and related searches. Use it to pull search results from our service to display on your agency’s website or mobile applications.

See a feature comparison between our Results API modules and our hosted search results page.

Clicks API - Use this API with the Search Results API to send click data into the system for analysis.

Typeahead API - This API exposes the typeahead suggestions that often appear below your search box as searchers enter their search terms. We recommend, however, that instead of using this API you use our javascript snippet that will call the API for you.

Source Code (Public Github Repositories)

search-gov — The source code that runs our core component app, including indexing processes, search request handling, our hosted results page, and Admin Center.

i14y — The source code that runs our search engine for agencies’ published content. i14y indexes agencies’ published content, for search through our regular search channels.

Punchcard — The repository of synonyms, protected words, stop words, and other vocabularies that we use to improve the precision, recall, and usability of search results.

search-gov-website — Pages and layout for our website, https://search.gov.

Unique Child Attribute — activerecord-validate_unique_child_attribute is an ActiveRecord extension to enforce uniqueness validations when accepting nested attributes.

Robots Tag Parser — A gem that parses X-Robots-Tag HTTP headers to aid in our indexing.