get_holder_segments
Read · Sign-in needed
Size your holder segments
How many reachable subscribers (verified, not opted out) are in each holder segment, and the size of the audience you select: all, new_7d (joined in the last 7 days), churned (sold everything), reduced_50 (cut their position by half or more), whales (top 1% or $10k+), top_10, top_25, top_50, top_100. audience.reachableByDM is how many of those the bot can DM on Telegram or Discord. Owner or manager; wallet session only.
Use it before a broadcast or a reward to see who a selection reaches. The mistake to avoid: a token page id repeats across chains; pass chain so the right token's ownership is checked.
| Reads or changes | Reads only |
| Sign-in | Yes |
| Scope | api:read |
| Calls | GET /api/v2/registration/{id}/holders/segments (API Explorer) |
Input
JSON Schema, as the server serves it.
json
{
"additionalProperties": false,
"properties": {
"chain": {
"description": "Chain key, `^[a-z0-9-]{1,32}$`",
"type": "string"
},
"id": {
"description": "The token page's id (the registration's numeric token id)",
"format": "int64",
"minimum": 1,
"type": "integer"
},
"segments": {
"description": "Comma-separated segments to size as one audience. An unknown name is 400.",
"examples": [
"whales,top_25"
],
"type": "string"
},
"tierId": {
"description": "Narrow everything to one holder group",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}Example
A tools/call request:
json
{
"name": "get_holder_segments",
"arguments": {
"id": 1
}
}