FAQ

  1. What is the PLOS Search API?
  2. What is Solr?
  3. Are there any examples using the PLOS Search API?
  4. Recommended Usage of the PLOS Search API
  5. How do I request a PLOS API key?
  6. How do I use the PLOS API key?
  7. I have questions about using the PLOS Search API. Where can I get answers?

What is the PLOS Search API?

The entire PLOS corpus of research articles is regularly indexed on PLOS servers running Apache Solr. PLOS provides programmatic access to the Solr API via the http://api.plos.org/search endpoint. Documentation for Solr queries can be found here. The PLOS endpoint uses “search” instead of the “select” used in the Solr documentation and requires an api key to identify api users.

Ex: http://api.plos.org/search?q=id:"10.1371/journal.pone.0169045"&api_key=1234567

What is “Solr”?

Solr is an open-source search platform from the Apache Lucene project. Essentially, Lucene is a Java-based indexing and search tool. Solr provides a friendly way to query Lucene and format the results. PLOS uses Solr version 4.1.0.

Are there any exampleS using the PLOS Search API?

Two pieces of information are necessary to effectively use the PLOS Search API. First, being familiar with the search fields used to index documents allows direct searching of specific article sections. Second, understanding construction of valid Solr queries using these fields will enable the development of search scripts in the programming language of choice. Example queries can be found on PLOS Solr Query Examples.

How do I request a PLOS API key?

See PLOS API Registration.

How do I use the PLOS API key?

Any request made to the PLOS API must include the argument api_key=[your PLOS API key]. That’s it!

I have questions about using the PLOS Search API. Where can I get answers?

If you have any questions or comments about the Article-Level Metrics application, head over to the PLOS API Community page for information on the PLOS API developers group.