Chats

Chats

1. Get Chat Information by Group Username

GET https://api.qa.trendmoon.ai/chats/{group_username}

Description:

Retrieves detailed information about a specific chat group identified by its unique Telegram username.

Parameters:

• group_username (string, required): Telegram group username

Example request:

curl -X GET "https://api.qa.trendmoon.ai/chats/solana" \
   -H "accept: application/json" \
   -H "Api-key: YOUR_API_KEY"

Example Response:

{
    "group_username": "arbitrum",
    "chat_id": 1634089218,
    "title": "Arbitrum Announcements Official",
    "member_count": 13278,
    "blacklisted": false,
    "blacklist_reason": "None",
    "description": "This is the only official English Telegram channel for Arbitrum announcements and updates.",
    "administrator_count": 0,
    "restricted_count": 0,
    "banned_count": 0,
    "is_verified": false,
    "is_scam": false,
    "is_fake": false
}

Response Fields:

• group_username (string)

  • Telegram group username

• chat_id (integer)

  • Internal Telegram chat ID

• title (string)

  • Title of the Telegram group

• member_count (integer)

  • Number of members in the Telegram group

• blacklisted (boolean)

  • Indicates if the chat has been blacklisted

• blacklist_reason (string)

  • Reason for blacklisting, if applicable

• description (string)

  • Description of the Telegram channel

• administrator_count (integer)

  • Number of administrators in the Telegram channel

• restricted_count (integer)

  • Number of members that have been restricted

• banned_count (integer)

  • Number of users that have been banned

• is_verified (boolean)

  • Indicates if the chat has been verified

• is_scam (boolean)

  • Indicates if the chat has been flagged as a scam

• is_fake (boolean)

  • Indicates if the chat has been flagged as fake

Chat Activity Endpoints

1. Get Chat Activity

GET https://api.qa.trendmoon.ai/chat_activity

Parameters:

• group_username (string, required): Telegram group username

• start_date (datetime, required)

• end_date (datetime, required)

• from_ (int, optional, default=0)

• size (int, optional, default=100)

Response:

[
    {
        "chat_id": 1012147388,
        "date": "2024-09-04T00:00:00",
        "group_username": "whalepoolbtc",
        "member_count": 6642,
        "num_messages": 212,
        "title": "Whalepool",
        "num_unique_users": 39,
        "member_online_count": 385,
        "daily_growth_messages": -31.832797427652736,
        "weekly_growth_messages": 50.79365079365079,
        "daily_growth_unique_users": -7.14285714285714,
        "weekly_growth_unique_users": -2.3076923076923217,
        "description": "",
        "administrator_count": 0,
        "restricted_count": 0,
        "banned_count": 0,
        "is_verified": 0,
        "is_scam": 0,
        "is_fake": 0,
        "gini_coefficient": 0.5633768746976294,
        "top_user_ratio": 0.13679245283018868,
        "is_well_distributed": false
    }
]

Response Fields:

• chat_id (integer)

  • Internal Telegram chat ID

• date (string)

  • Date for which the activity data is recorded (ISO 8601 format)

• group_username (string)

  • Telegram group username

• member_count (integer)

  • Total number of members in the chat

• num_messages (integer)

  • Number of messages sent in the chat on the given date

• title (string)

  • Title of the chat

• num_unique_users (integer)

  • Number of unique users participating in the chat on the given date

• member_online_count (integer)

  • Number of members online in the chat at the given time

• daily_growth_messages (float)

  • Percentage change in message count compared to the previous day

• weekly_growth_messages (float)

  • Percentage change in message count compared to the previous week

• daily_growth_unique_users (float)

  • Percentage change in unique users compared to the previous day

• weekly_growth_unique_users (float)

  • Percentage change in unique users compared to the previous week

• gini_coefficient (float)

  • Measure of message participation equality (0 = equal, 1 = highly unequal)

• top_user_ratio (float)

  • Fraction of messages sent by the most active user

• is_well_distributed (boolean)

  • Whether the conversation is evenly distributed among members

Additional Notes:

Gini Coefficient

Range: 0 to 1

• Range: 0 to 1

• 0 = perfect equality (everyone sends the same number of messages)

• 1 = perfect inequality (one person sends all messages)

Interpretation for Telegram Groups:

• < 0.3: Very even participation

• 0.3-0.5: Moderately even participation

• 0.5-0.7: Somewhat uneven participation

• 0.7: Highly concentrated participation

Top user ratio

Range: 0 to 1

• Range: 0 to 1

• 0.1 means the top user sent 10% of all messages

• 0.5 means the top user sent 50% of all messages

Interpretation for Telegram Groups:

• < 0.2: Healthy distribution

• 0.2-0.4: Moderate concentration

• 0.4: High concentration