Skip to content
Back to top
View this page
Edit this page

# Astrophysics Data System (ADS)

The Astrophysics Data System (ADS) is a digital library portal for researchers in astronomy and physics, operated by the Smithsonian Astrophysical Observatory (SAO) under a NASA grant. The ADS is a solr instance, but not with the standard API paths.

Note

The ADS engine requires an `API key`.

This engine uses the search/query API endpoint. Since the user’s search term is passed through, the search syntax of ADS can be used (at least to some extent).

## Configuration

The engine has the following additional settings:

- `api_key`

- `ads_sort`

    - name: astrophysics data system
      api_key: "..."
      inactive: false

## Implementations

searx.engines.astrophysics_data_system.api_key = 'unset'

  Get an API token as described in https://ui.adsabs.harvard.edu/help/api

searx.engines.astrophysics_data_system.ads_field_list = ['abstract', 'author', 'bibcode', 'comment', 'date', 'doi', 'isbn', 'issn', 'keyword', 'page', 'page_count', 'page_range', 'pub', 'pubdate', 'pubnote', 'read_count', 'title', 'volume', 'year']

  Set of fields to return in the response from ADS.

searx.engines.astrophysics_data_system.ads_rows = 10

  How many records to return for the ADS request.

searx.engines.astrophysics_data_system.ads_sort = 'read_count desc'

  The format is ‘field’ + ‘direction’ where direction is one of ‘asc’ or ‘desc’ and field is any of the valid indexes.

searx.engines.astrophysics_data_system.setup(engine_settings: dict[str, Any]) → bool

  Initialization of the ADS engine, checks whether the `api_key` is set, otherwise the engine is inactive.