across.client.apis.instrument

Classes

Instrument

Client for interacting with Instrument resources in the Across API.

Module Contents

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

Client for interacting with Instrument resources in the Across API.

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

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

Retrieve a single Instrument by ID.

Parameters:

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

Returns:

The requested Instrument object.

Return type:

sdk.Instrument

get_many(name: str | None = None, telescope_name: str | None = None, telescope_id: str | None = None, created_on: datetime.datetime | None = None) → list[across.sdk.v1.Instrument][source]

Retrieve multiple instruments filtered by optional criteria.

Parameters:

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

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

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

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

Returns:

A list of instruments matching the given filters.

Return type:

list[sdk.Instrument]