In line with the White House’s Digital Government Strategy, we’re making our code and data more open.
APIs for Search.gov Customers
These APIs are available for use on official government websites only. You must be a Search.gov customer. Sign in is required.
i14y—This API allows you to send content directly from your content management system (CMS) into Search.gov for real-time indexing. Instructions can be found under Admin Center > YourSite > Content > i14y. Request your site be activated for i14y to enable this section.
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 tweets, 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. Instructions can be found under Admin Center > YourSite > Activate Search.
Type-ahead API—This API exposes the type-ahead suggestions that often appear below your search box as searchers enter their search terms. Instructions can be found under Admin Center > YourSite > Activate Search.
APIs and Data Feeds for the Public
Important Note: The Jobs API will be deprecated early 2019. Please use the USAJOBS API instead.
Taps into a list of current jobs openings in federal agencies. Jobs are searchable by keyword, location, agency, schedule, or any combination of these.
Visit USA.gov/Developer for a full list of USA.gov’s APIs and data feeds available to the public.
Source Code (Public Github Repositories)
ASIS (Advanced Social Image Search)—The source code that runs our image search. ASIS indexes images from Flickr, Instagram, and media RSS to provide a combined search API.
i14y—The source code that runs our search engine for agencies’ published content. i14y indexes agencies’ published content in real time, for search through our regular search channels.
Jobs— Slated for deprecation. Please use the USAJOBS API instead. The source code that runs our jobs search and Jobs API. Indexes current jobs openings in federal agencies.
Non-.gov URLs—The source code that runs our non-.gov URLs API. Indexes all government URLs that don’t end in .gov or .mil.
Punchcard—The repository of synonyms, protected words, stop words, localizations, and other vocabularies that we use to improve the precision, recall, and usability of search results.
search.digitalgov.gov—Pages and layout for our website, https://search.gov.
Site Links—The source code that “decorates” organic web results to provide additional, value-added links to help searchers find what they’re looking for. Currently provides one-click links to EDGAR filings for relevant SEC.gov results. Also published as a Ruby gem at https://rubygems.org/gems/sitelink_generator.
Unique Child Attribute—activerecord-validate_unique_child_attribute is an ActiveRecord extension to enforce uniqueness validations when accepting nested attributes. Works around Rails issue #4568.
CMS Modules and Plugins
These modules and plugins were developed by Search.gov customers, not us, but we’re linking to them here so you have easy access to them. Use their respective platforms to connect with their developers and submit issues.
Drupal Module—Allows you to connect your Drupal website to your Search.gov search configuration. The module also supports realtime indexing via Search.gov’s i14y content indexing API. Check out our help docs here.
WordPress Plugin—Starter code - contributions welcome! This plugin allows you to override the default WordPress search and connect your WordPress-powered website to your Search.gov search configuration.