This module provides a framework for easily creating searches on any entity known to Drupal, using any kind of search engine. For site administrators, it is a great alternative to other search solutions, since it already incorporates facetting support and the ability to use the Views module for displaying search results, filters, etc. Also, with the Apache Solr integration, a high-performance search engine is available for this module.
Developers, on the other hand, will be impressed by the large flexibility and numerous ways of extension the module provides. Hence, the growing number of additional contrib modules, providing additional functionality or helping users customize some aspects of the search process.

The prime example of a site using this module is itself – the Search API, along with the database backend and Views, is used to generate the issue queue listings.

Note on security

In general, the Search API doesn't provide any kind of access restrictions (as this cannot be done on a generic level). It is therefore your responsibility to take care that only accessible items are indexed or results displayed (e.g., by using appropriate filters).
There is, however, built-in support for node access checks via the Node access data alteration (q.v. for details). Also, the Search views module contains an option to do additional access checks on all entities in search views.

Additional modules

At the moment, this project contains, apart from the core API module, the following extension modules:

Search views

This module integrates the Search API with the Views module, allowing searches on any index to be created and viewed via Views. All of an entity's properties, as well as those of related entities (e.g. a node's author's name), are available as fields, filters and arguments for all indexed fields are available and sorts (as well as click sorts) can be created on any indexed single-valued field. Also some additional features, like linking the results to the entity, are available.

Search facets

This module provides the ability to create facets on any search executed anywhere in Drupal, be it a search page, a view or any other source. The feature isn't available for all servers, though, since it would be too complex to implement for some service classes. Right now only the Solr servers support this, facet support for the database-based searches might be done in the future.

Tutorials and screencasts

A number of tutorials and screencasts are linked in the handbook. Especially the latest screencasts from DrupalCon sessions might provide a good introduction to the module.

Other available backends and extensions

You can find a list of available extension modules in the handbook.


You will have to download and enable the Entity API module to use the Search API.
To use the Views integration, you'll (of course) also need the Views module.
Furthermore, you'll need to enable at least one module that provides a service class.

Information for developers

Extensive documentation for other developers, who might want to extend the framework's capabilities themselves, is available. It is partly included in the module itself (in search_api.api.php, in README.txt and directly in the relevant classes and interfaces) and partly in the online handbook.
If you are trying to implement some extension point and are stuck, please don't hesitate to ask in the module's issue queue. Please also add your module to the list of extension modules (linked above)

All developers working in the Search API ecosystem are advised to keep an eye on #1188562: [meta] Important project announcements for important updates. (Could also contain useful information for site builders.)

Drupal 8 version

A Drupal 8 version of the module is currently being worked on, though far from being usable. If you want to follow (or, even better, help with) development, please see #2044421: [meta] Upgrade to Drupal 8 and the Search API 8.x sandbox.

#D8CX: I pledge that Search API will have a full Drupal 8 release on the day that Drupal 8 is released.


This project was developed as part of the Google Summer of Code
2010 (detailed information).
Some further development was sponsored by epiqo.

If you are interested in sponsoring a particular feature or new related module, please contact me. I'm also available for consulting.

Project Information