get_stars_transactions()

Client.get_stars_transactions()

Get stars transactions.

Usable by Users Bots
Parameters:

  • chat_id (int | str, optional) – Unique identifier (int) or username (str) of the target user. You can also use chat public link in form of t.me/<username> (str). default to self. only for bots.

  • limit (int, optional) – Limits the number of transactions to be retrieved.

  • offset (str, optional) – Offset the list of transactions to be retrieved.

  • is_inbound (bool, optional) – True, if only inbound transactions should be retrieved.

  • is_outbound (bool, optional) – True, if only outbound transactions should be retrieved.

  • is_ascending (bool, optional) – True, if transactions should be returned in ascending order.

Example

# get all transactions
app.get_stars_transactions()

# get all inbound transactions
app.get_stars_transactions(is_inbound=True)

# get all outbound transactions
app.get_stars_transactions(is_outbound=True)

# get all transactions in ascending order
app.get_stars_transactions(is_ascending=True)
Returns:

StarsStatus – On success, a StarsStatus object is returned.