API

Data models

These are the top-level data models that most users will need. They are actually defined within ads.models, but are imported to the ads namespace for convenience (e.g., ads.Document is imported from ads.models.document.Document).

ads.Document

A document in the SAO/NASA Astrophysics Data System.

ads.Library

A data model for a library managed by ADS.

ads.Journal

A published journal.

ads.Affiliation

An author affiliation recognised by ADS.

All other classes and functions associated with data models live in ads.models.

ads.models

Data models for ADS objects.

Services

ADS offers a large number of services. This package exposes the most relevant ones.

Some services have single API end-points that only need a HTTP request using ads.client.Client. But for services that have a data model (e.g., the search service (ads.services.search uses the ads.Document data model), these pages document how methods on data model classes are translated to the appropriate ADS service and API end-point.

ads.services

Expose specific ADS services.

Client

ads.client

Client for handling API requests to ADS.

Exceptions and warnings

ads.exceptions.APIResponseError

An exception that is raised when the ADS API returns an error.

ads.models.lazy.LazyAttributesWarning

Utilities

ads.utils

General utilities.