Social sentiment
Description
Provides market sentiment indicators for a single token, including bullish, bearish, and neutral opinion ratios and summarized content.
Use cases:
- Comprehensive market sentiment analysis for a token
- Combine with capital flow data to analyze the relationship between sentiment and price
- Judge market bullish/bearish bias
Tips:
- Call this API when natural language input mentions market sentiment, and also call the real-time capital data API for analysis
Data refresh: Updated every 30 minutes
Endpoint
- Method:
POST - Path:
/open/v1/social-sentiment/getCoinSocialSentiment
Points
- Points per call:
2
Prerequisites
Obtaining
vsTokenId
| Condition | Description | How to obtain |
|---|---|---|
Already have vsTokenId | Use the cached vsTokenId directly; no need to query again | Extracted automatically from context |
Do not have vsTokenId | Call POST /vs-token/list | Prerequisite API call |
Request parameters
Parameters are sent in the request body as JSON.
| Parameter | Type | Required | Description |
|---|---|---|---|
| vsTokenId | long | Yes | Token ID |
Response fields
Field structure inside the data object only:
| Field | Type | Actual serialized type | Description |
|---|---|---|---|
| updateTime | long | long | Data update time (millisecond timestamp) |
| vsTokenId | long | string | Token ID |
| symbol | string | string | Token symbol |
| name | string | string | Token name |
| bullishRatio | number | number | Bullish sentiment ratio (0–1) |
| neutralRatio | number | number | Neutral sentiment ratio (0–1) |
| bearishRatio | number | number | Bearish sentiment ratio (0–1) |
| bearishContents | array | array | Bearish summary content list |
| english | string | string | English content |
| updateTime | long | long | Content update time (millisecond timestamp) |
| neutralContents | array | array | Neutral summary content list |
| english | string | string | English content |
| updateTime | long | long | Content update time (millisecond timestamp) |
| bullishContents | array | array | Bullish summary content list |
| english | string | string | English content |
| updateTime | long | long | Content update time (millisecond timestamp) |
Field semantics
The following fields require additional business context:
| Field | Business meaning | Range / calculation | Usage suggestion |
|---|---|---|---|
| bullishRatio | Bullish sentiment ratio | 0–1, based on social content sentiment analysis | Closer to 1 indicates a more bullish market |
| neutralRatio | Neutral sentiment ratio | 0–1, based on social content sentiment analysis | Represents the share of wait-and-see sentiment |
| bearishRatio | Bearish sentiment ratio | 0–1, based on social content sentiment analysis | Closer to 1 indicates a more bearish market |
| bullishContents | Bullish content summary | AI summary of social content | Understand specific reasons for bullish sentiment |
| bearishContents | Bearish content summary | AI summary of social content | Understand specific reasons for bearish sentiment |
Request example
json
{
"vsTokenId": 1 // Token ID (vsTokenId)
}cURL example (Linux/macOS)
bash
curl --location --request POST 'http://${host}/api/open/v1/social-sentiment/getCoinSocialSentiment' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: xxxxx' \
--header 'X-TIMESTAMP: xxxxx' \
--header 'X-SIGN: xxxxx' \
--header 'Accept: */*' \
--data-raw '{
"vsTokenId": 1
}'cURL example (Windows CMD)
cmd
curl --location --request POST "http://${host}/api/open/v1/social-sentiment/getCoinSocialSentiment" ^
--header "Content-Type: application/json" ^
--header "X-API-KEY: xxxxx" ^
--header "X-TIMESTAMP: xxxxx" ^
--header "X-SIGN: xxxxx" ^
--header "Accept: */*" ^
--data-raw "{ \"vsTokenId\": 1}"Sample success response
json
{
"code": 200,
"message": "success",
"data": {
"updateTime": 1773315931000, // Data update time
"vsTokenId": "1", // Token ID (vsTokenId)
"symbol": "BTC", // Token symbol
"name": "Bitcoin", // Token name
"bullishRatio": 0.4113, // Bullish sentiment ratio
"neutralRatio": 0.4937, // Neutral sentiment ratio
"bearishRatio": 0.095, // Bearish sentiment ratio
"bearishContents": [
{
"english": "$BTC faces conflicting narratives...", // English content
"updateTime": 1773316047000 // Content update time
},
{
"english": "$BTC faces intense bearish pressure...",
"updateTime": 1773314274000
},
{
"english": "Whales and treasury entities...",
"updateTime": 1773312461000
}
// ... more items omitted
],
"neutralContents": [
{
"english": "Whales and institutional actors...",
"updateTime": 1773316047000
},
{
"english": "$BTC remains central to macro speculation...",
"updateTime": 1773312461000
},
{
"english": "$BTC faces immediate resistance at $70K...",
"updateTime": 1773310591000
}
// ... more items omitted
],
"bullishContents": [
{
"english": "$BTC shows strong bullish conviction...",
"updateTime": 1773316047000
},
{
"english": "Whales are driving momentum...",
"updateTime": 1773314274000
},
{
"english": "Whales are reactivating long-dormant...",
"updateTime": 1773312461000
}
// ... more items omitted
]
},
"requestId": "xxx-xxx-xxx"
}