across.client.apis.telescope

Classes

Telescope

Client for interacting with Telescope resources in the Across API.

Module Contents

class Telescope(across_client: across.sdk.v1.api_client_wrapper.ApiClientWrapper)[source]

Client for interacting with Telescope resources in the Across API.

Provides methods to retrieve single or multiple telescopes by ID, name, instrument information, or creation date.

across_client[source]
get(id: str) → across.sdk.v1.Telescope[source]

Retrieve a single Telescope by ID.

Parameters:

id (str) – The unique identifier of the Telescope to retrieve.

Returns:

The requested Telescope object.

Return type:

sdk.Telescope

get_many(name: str | None = None, observatory_id: str | None = None, observatory_name: str | None = None, instrument_name: str | None = None, instrument_id: str | None = None, created_on: datetime.datetime | None = None, include_filters: bool | None = None, include_footprints: bool | None = None) → list[across.sdk.v1.Telescope][source]

Retrieve multiple telescopes filtered by optional criteria.

Parameters:

  • name (str | None, optional) – Filter by telescope name.

  • observatory_id (str | None, optional) – Filter by observatory ID.

  • observatory_name (str | None, optional) – Filter by observatory name.

  • instrument_name (str | None, optional) – Filter by instrument name.

  • instrument_id (str | None, optional) – Filter by instrument ID.

  • created_on (datetime | None, optional) – Filter by creation timestamp.

  • include_filters (bool | None, optional) – Include telescope instrument filters with the returned values (defaults to False)

  • include_footprints (bool | None, optional) – Include telescope instrument footprints with the returned values (defaults to False)

Returns:

A list of telescopes matching the given filters.

Return type:

list[sdk.Telescope]