mmspy.api.query.Query

class mmspy.api.query.Query(start_time=None, stop_time=None, probe=None, instrument=None, data_rate=None, data_type=None, data_level=None, ancillary_product=None)

Query parameters for the MMS SDC.

This class is not supposed to be initialized directly. Rather, it should be used through the package-level mmspy.query instance.

For detailed descriptions of the web services and the query parameters, see the SDC website. For usage examples, see the Attributes and Examples sections below.

Parameters:

• start_time (date-like, optional) – API equivalence: start_date.

• stop_time (date-like, optional) – API equivalence: stop_date.

• probe (str, optional) – API equivalence: sc_id.

• instrument (str, optional) – API equivalence: instrument_id.

• data_rate (str, optional) – API equivalence: data_rate_mode.

• data_type (str, optional) – API equivalence: descriptor.

• data_level (str, optional) – API equivalence: data_level.

• ancillary_product (str, optional) – API equivalence: product.

__init__(start_time=None, stop_time=None, probe=None, instrument=None, data_rate=None, data_type=None, data_level=None, ancillary_product=None)

Method generated by attrs for class Query.

Methods

__init__([start_time, stop_time, probe, ...])	Method generated by attrs for class Query.
get_payload([cdf_file_name])	Get the HTTP payload constructed from query parameters.
get_url(command[, data])	Get the url for a HTTP request.
reset()	Reset the query.
restore_state()
save_state()	Save the current query.
show()
summary()
update(**kwargs)	Update the query with init parameters.

Attributes

start_time	Query start time in acceptable format for Timestamp, e.g., YYYY-MM-DD, YYYY-MM-DD/hh:mm:ss, or YYYY-MM-DDThh:mm:ss.ssssss.
stop_time	Query stop time in acceptable format for Timestamp, e.g., YYYY-MM-DD, YYYY-MM-DD/hh:mm:ss, or YYYY-MM-DDThh:mm:ss.ssssss.
probe	Probe name.
instrument	Instrument name.
data_rate	Data rate mode.
data_type	Data descriptor.
data_level	Data level.
ancillary_product	Ancillary product (unsupported).
center_time
local_path	Path to the local store.
metadata	Return the query's metadata.
remote_path	Path to the remote store.