List all messages

Returns

Returns a list of Messages that have previously been created for the queried parameters.

Only one msgType can be queried at a time. All other query parameters are arrays of one or multiple values.

Usage

import { messages } from 'aleph-js'

await messages.get_messages()

// Or with optional parameters
await messages.get_messages({pagination: 200, tags: ["first_tag", "second_tag"]})

Required parameters

No parameters are required.

Optional parameters

An object of options to further filter the list of posts returned.

  • api_server - string

    Default: "https://api1.aleph.im"

    Target API server

  • pagination - integer

    Default: 200

    The number of messages returned per page

  • page - integer

    Default: 1

    The number of pages returned

  • message_type - string: "POST", "AGGREGATE" or "STORE"

    Default: null

    A string representing the Message type. Value can be: POST, AGGREGATE, or STORE

  • content_types - array

    Default: null

    Array of Message content types (item_content.type)

  • refs - array

    Default: null

    Array of Refs listed in content refs (item_content.ref)

  • addresses - array

    Default: null

    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 - array

    Default: null

    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 - array

    Default: null

    Array of hashes listed in the item hash (item_hash) or transaction hash (tx_hash)

Historical changes for a post

Last updated