pyAstroApi
latest

Contents

  • Installation
  • Examples
  • Development
  • High-level API Reference
    • pyastroapi.articles
    • pyastroapi.libraries
    • pyastroapi.search
      • search()
  • Low-level API Reference
  • Extra utilities
  • API Reference
pyAstroApi
  • High-level API Reference
  • pyastroapi.search
  • Edit on GitHub

pyastroapi.search

pyastroapi.search(query: str, limit: int = -1, fields: List[str] = None, dbg: bool = False)

Performs an ADS search

Parameters:
  • query (str) – Search query

  • limit (int, optional) – Number of rows to limit to (-1 is no limit). Defaults to -1.

  • fields (t.List[str], optional) – ADS fields to return, if None returns a default set of fields.

  • dbg (bool, optional) – Debugging flag. Defaults to False.

Returns:

Returns a generator where each element is a dict for each ADS record, with keys given by the fields

Return type:

generator

Previous Next

© Copyright 2022, Rob Farmer. Revision b1750f95.

Built with Sphinx using a theme provided by Read the Docs.