List all

Returns

A list of Messages of one msgType that have previously been created for the queried parameters.

Usage

def get_messages(
    pagination:,
    page,
    message_type,
    content_types,
    refs,
    addresses,
    tags,
    hashes,
    channels,
    start_date,
    end_date,
    session,
    api_server,
)

Required Arguments

All arguments are optional. If none are passed, all messages will be returned for the default argument values.

Optional Arguments

• pagination - integer Default: 200 Number of messages returned per page

• page - integer Default: 1 The number of pages returned

• message_type - string Default: None A string representing the Message type. Only one type can be queried at a time. Value can be: POST, AGGREGATE, or STORE

• content_types - iterable of strings Default: None Array of Message content types (item_content.type)

• refs - iterable of strings Default: None Array of Refs listed in content refs (item_content.ref)

• addresses - iterable of strings Default: None Array of addresses listed in the content address (item_content.address) or sender (sender) attribute of the Message.

  If multiple addresses are passed, any message with one of the queried addresses in the content address or sender attribute will be returned.

• tags - iterable of strings Default: None Array of Message content content tag. (item_content.content.tags).

  If multiple tags are passed, messages with at least one of the tags present in the content content tags will be returned.

• hashes - iterable of strings Default: None Array of hashes listed in the item hash (item_hash) or transaction hash (tx_hash)

• channels - iterable of strings Default: None

  Array of channels

• start_date - datetime or float (timestamp) Default: None Filtering messages on the time attribute (time).

  If only the start date is passed, messages with time greater than the start date will be returned. If both start and end dates are passed, messages with time in between start date and end date will be returned.

• end_date - datetime or float (timestamp) Default: None If only the end date is passed, messages with time less than the end date will be returned. If both start and end dates are passed, messages with time in between start date and end date will be returned.

• session Default: None

• api_server - string Default: https://api2.aleph.im Target API server