Community

Social score for Protocols

Retrieves the available protocols ids for use in social endpoints

This endpoint returns the protocol ids for use in our social endpoints.

GEThttps://api.alterscope.org/scores/social/protocols/{channel}

Path parameters

channel*string

the name of the channel in lowercase. Currently we are supporting discord and reddit

Response

200404505

OK

Body

application/json

name*string

protocol_id*string

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/scores/social/protocols/{channel}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "Aave",
  "protocol_id": "aave"
}

Sample Request

The sample request below retrieves available protocols ids for use in social endpoints for a discord channel.

curl https://api.alterscope.org/scores/social/protocols/discord -H "Authorization: Bearer <your_access_token>"

Note: Currently discord and reddit are supported channels.

Sample Response

{
   "status":true,
   "data":[
      {
         "name":"Aave",
         "protocol_id":"aave"
      },
      {
         "name":"Uniswap",
         "protocol_id":"uniswap"
      },
      {
         "name":"Compound",
         "protocol_id":"compound"
      },
      {
         "name":"Curve",
         "protocol_id":"curve"
      },
      {
         "name":"Chainlink",
         "protocol_id":"chainlink"
      },
      {
         "name":"Near",
         "protocol_id":"near"
      },
      {
         "name":"Ethereum",
         "protocol_id":"ethereum"
      },
      {
         "name":"Morpho",
         "protocol_id":"morpho"
      },
      {
         "name":"Notional",
         "protocol_id":"notional"
      },
      {
         "name":"Convex",
         "protocol_id":"convex"
      },
      {
         "name":"Yearn",
         "protocol_id":"yearn"
      },
      {
         "name":"Bitcoin",
         "protocol_id":"bitcoin"
      },
      {
         "name":"Idle",
         "protocol_id":"idle"
      },
      {
         "name":"Harvest",
         "protocol_id":"harvest"
      },
      {
         "name":"MakerDAO",
         "protocol_id":"makerdao"
      },
      {
         "name":"Frax Finance",
         "protocol_id":"frax"
      },
      {
         "name":"Liquity",
         "protocol_id":"liquity"
      },
      {
         "name":"Reflexer Finance",
         "protocol_id":"reflexer"
      },
      {
         "name":"Balancer",
         "protocol_id":"balancer"
      },
      {
         "name":"PancakeSwap",
         "protocol_id":"pancakeswap"
      },
      {
         "name":"Lido",
         "protocol_id":"lido"
      },
      {
         "name":"Dydx",
         "protocol_id":"dydx"
      },
      {
         "name":"GMX",
         "protocol_id":"gmx"
      },
      {
         "name":"Instadapp",
         "protocol_id":"instadapp"
      },
      {
         "name":"Chronos",
         "protocol_id":"chronos"
      },
      {
         "name":"Synthetix",
         "protocol_id":"synthetix"
      },
      {
         "name":"Swaap Protocol",
         "protocol_id":"swaap"
      },
      {
         "name":"Velodrome",
         "protocol_id":"velodrome"
      },
      {
         "name":"Maverick protocol",
         "protocol_id":"maverick"
      },
      {
         "name":"Optimism",
         "protocol_id":"optimism"
      },
      {
         "name":"Arbitrum",
         "protocol_id":"arbitrum"
      },
      {
         "name":"Radiant Capital",
         "protocol_id":"radiant"
      }
   ]

Sample Response Description

name: Name of the chain or protocol protocol_id: Protocol id of the chain or protocol.

Retrieves the Discord score data with other information

This endpoint returns the social scores of the Discord Server for the specified protocol from the last 7 days.

GEThttps://api.alterscope.org/scores/social/discord/{protocol}

Authorization

BearerAuth

Path parameters

protocol*string

the name of the protocol in lowercase

Response

200404505

OK

Body

application/json

channelstring

daily_message_countinteger

number_of_unique_usersinteger

average_sentiment_scorenumber (double)

high_level_topic_frequencyarray of TopicFrequency (object)

mid_level_topic_based_sentiment_distributionarray of TopicSentimentDistribution (object)

timestampstring (date-time)

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/scores/social/discord/{protocol}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "channel": "text",
  "average_sentiment_score": 0,
  "high_level_topic_frequency": [
    {
      "topic": "text"
    }
  ],
  "mid_level_topic_based_sentiment_distribution": [
    {
      "topic_name": "text"
    }
  ],
  "timestamp": "2024-05-14T11:49:57.484Z"
}

Sample Request

Note: The sample request below retrieves discord score data with other information for compound protocol.

curl https://api.alterscope.org/scores/social/discord/compound -H "Authorization: Bearer <your_access_token>"

For a supported list of protocols whose data can be requested please refer to supported protocols page.

Sample Response

The sample response below is shortened for formatting purposes. The actual response will contain data for past 7 days.

{
   "status":true,
   "data":[
      {
         "channel":"discord",
         "daily_message_count":19,
         "number_of_unique_users":7,
         "average_sentiment_score":0.4736842105263158,
         "high_level_topic_frequency":[
            {
               "topic":"DeFi and Yield Farming",
               "frequency":7
            },
            {
               "topic":"Other",
               "frequency":4
            },
            {
               "topic":"Community and Communication",
               "frequency":4
            },
            {
               "topic":"Technical Discussions and Support",
               "frequency":3
            },
            {
               "topic":"Price and Market Discussions",
               "frequency":1
            }
         ],
         "mid_level_topic_based_sentiment_distrubution":[
            {
               "topic_name":"APR and Projected APY Discussion",
               "count":1,
               "neutral_sentiment_count":1,
               "positive_sentiment_count":0,
               "negative_sentiment_count":0
            },
            {
               "topic_name":"Aave DAO Governance Proposal Forum",
               "count":1,
               "neutral_sentiment_count":1,
               "positive_sentiment_count":0,
               "negative_sentiment_count":0
            },
            {
               "topic_name":"Appreciation for Help and Guidance",
               "count":1,
               "neutral_sentiment_count":1,
               "positive_sentiment_count":0,
               "negative_sentiment_count":0
            },
            {
               "topic_name":"Best Ask Questions Guidance",
               "count":2,
               "neutral_sentiment_count":2,
               "positive_sentiment_count":0,
               "negative_sentiment_count":0
            },
            {
               "topic_name":"Blockchain Partnership and Project Discussions",
               "count":1,
               "neutral_sentiment_count":0,
               "positive_sentiment_count":1,
               "negative_sentiment_count":0
            },
            {
               "topic_name":"Canceling Pending Transactions",
               "count":1,
               "neutral_sentiment_count":0,
               "positive_sentiment_count":0,
               "negative_sentiment_count":1
            },
            {
               "topic_name":"Chainlink Oracle Node Services",
               "count":1,
               "neutral_sentiment_count":1,
               "positive_sentiment_count":0,
               "negative_sentiment_count":0
            },
            {
               "topic_name":"Claiming and Tracking Rewards",
               "count":4,
               "neutral_sentiment_count":2,
               "positive_sentiment_count":0,
               "negative_sentiment_count":2
            },
            {
               "topic_name":"Collateral Borrowing and Liquidation",
               "count":1,
               "neutral_sentiment_count":1,
               "positive_sentiment_count":0,
               "negative_sentiment_count":0
            },
            {
               "topic_name":"DAI, DSR, SDAI and Surplus Buffer",
               "count":2,
               "neutral_sentiment_count":2,
               "positive_sentiment_count":0,
               "negative_sentiment_count":0
            },
            {
               "topic_name":"Decentralized Contract and Token Discussions",
               "count":1,
               "neutral_sentiment_count":1,
               "positive_sentiment_count":0,
               "negative_sentiment_count":0
            },
            {
               "topic_name":"LUSD Stablecoin Peg Stability Discussion",
               "count":1,
               "neutral_sentiment_count":1,
               "positive_sentiment_count":0,
               "negative_sentiment_count":0
            },
            {
               "topic_name":"Sending DMs and Friend Requests",
               "count":1,
               "neutral_sentiment_count":0,
               "positive_sentiment_count":1,
               "negative_sentiment_count":0
            },
            {
               "topic_name":"Twitter Account Activity and Announcements",
               "count":1,
               "neutral_sentiment_count":1,
               "positive_sentiment_count":0,
               "negative_sentiment_count":0
            }
         ],
         "timestamp":"2023-12-14T00:00:00"
      },     

Sample Response Description

1. "channel": "discord"

   • This field indicates that the data and information provided are related to a Discord channel.

2. "daily_message_count"

   • This field represents the average number of messages posted daily in the Discord channel.

3. "number_of_unique_users"

   • This field signifies the count of distinct users who have participated in the Discord channel.

4. "average_sentiment_score"

   • This field presents the average sentiment score of the messages in the Discord channel, where sentiment is likely measured on a scale.

5. "high_level_topic_frequency"

   • This section provides a breakdown of the frequency of discussion topics at a high level in the Discord channel.

   • "topic": "DeFi and Yield Farming"

     • Frequency: 7

   • "topic": "Other"

     • Frequency: 4

   • "topic": "Community and Communication"

     • Frequency: 4

   • "topic": "Technical Discussions and Support"

     • Frequency: 3

   • "topic": "Price and Market Discussions"

     • Frequency: 1

6. "mid_level_topic_based_sentiment_distribution"

   • This section provides a more detailed breakdown of sentiment for specific mid-level topics in the Discord channel.

   • "topic_name": "APR and Projected APY Discussion"

     • Count: 1

     • Neutral Sentiment Count: 1

     • Positive Sentiment Count: 0

     • Negative Sentiment Count: 0

   (Additional mid-level topics and their sentiment breakdowns would follow in a similar format.)

Retrieves the Reddit score data with other information for past 7 days

This endpoint returns the social scores of the Subreddit for the specified protocol from the last 7 days.

GEThttps://api.alterscope.org/scores/social/reddit/{protocol}

Authorization

BearerAuth

Path parameters

protocol*string

the name of the protocol in lowercase

Response

200404505

OK

Body

application/json

channelstring

daily_message_countinteger

number_of_unique_usersinteger

average_sentiment_scorenumber (double)

high_level_topic_frequencyarray of TopicFrequency (object)

mid_level_topic_based_sentiment_distributionarray of TopicSentimentDistribution (object)

timestampstring (date-time)

Request

JavaScriptCurl

const response = await fetch('https://api.alterscope.org/scores/social/reddit/{protocol}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "channel": "text",
  "average_sentiment_score": 0,
  "high_level_topic_frequency": [
    {
      "topic": "text"
    }
  ],
  "mid_level_topic_based_sentiment_distribution": [
    {
      "topic_name": "text"
    }
  ],
  "timestamp": "2024-05-14T11:49:57.484Z"
}

Sample Request

The sample request below retrieves a reddit score data of a specific protocol with other information for past 7 days.

curl https://api.alterscope.org/scores/social/reddit/uniswap -H "Authorization: Bearer <your_access_token>"

For a supported list of protocols whose data can be requested please refer to supported protocols page.

Sample Response

{
   "status":true,
   "data":[
      {
         "channel":"reddit",
         "daily_message_count":3,
         "number_of_unique_users":0,
         "average_sentiment_score":0.33333333333333337,
         "high_level_topic_frequency":[
            {
               "topic":"Technical Discussions and Support",
               "frequency":1
            },
            {
               "topic":"Community and Communication",
               "frequency":1
            },
            {
               "topic":"Other",
               "frequency":1
            }
         ],
         "mid_level_topic_based_sentiment_distrubution":[
            {
               "topic_name":"Appreciation for Help and Guidance",
               "count":1,
               "neutral_sentiment_count":0,
               "positive_sentiment_count":0,
               "negative_sentiment_count":1
            },
            {
               "topic_name":"NFT Transactions and Fraud Prevention",
               "count":1,
               "neutral_sentiment_count":1,
               "positive_sentiment_count":0,
               "negative_sentiment_count":0
            },
            {
               "topic_name":"Uniswap Token Address Management",
               "count":1,
               "neutral_sentiment_count":1,
               "positive_sentiment_count":0,
               "negative_sentiment_count":0
            }
         ],
         "timestamp":"2024-01-13T00:00:00"
      }
}

Sample Response Description

• "channel": "reddit"

  • This field indicates that the data and information provided are related to a Reddit channel.

• "daily_message_count"

  • This field represents the average number of messages posted daily in the Reddit channel.

• "number_of_unique_users"

  • This field signifies the count of distinct users who have participated in the Reddit channel.

• "average_sentiment_score"

  • This field presents the average sentiment score of the messages in the Reddit channel, where sentiment is likely measured on a scale.

• "high_level_topic_frequency"

  • This section provides a breakdown of the frequency of discussion topics at a high level in the Reddit channel.

  • "topic": "DeFi and Yield Farming"

    • Frequency: 7

  • "topic": "Other"

    • Frequency: 4

  • "topic": "Community and Communication"

    • Frequency: 4

  • "topic": "Technical Discussions and Support"

    • Frequency: 3

  • "topic": "Price and Market Discussions"

    • Frequency: 1

• "mid_level_topic_based_sentiment_distribution"

  • This section provides a more detailed breakdown of sentiment for specific mid-level topics in the Reddit channel.

  • "topic_name": "APR and Projected APY Discussion"

    • Count: 1

    • Neutral Sentiment Count: 1

    • Positive Sentiment Count: 0

    • Negative Sentiment Count: 0

  (Additional mid-level topics and their sentiment breakdowns would follow in a similar format.)