AIXBT Docs

Reference

List Clusters

View as Markdown
GET
/v3/clusters

Audience/source archetypes used as an analysis dimension across Topics and Intel.

Authorization

ApiKeyAuth
x-api-key<token>

API key. The Authorization header is accepted as an equivalent carrier. Responses echo the credential class in X-API-Key-Type.

In: header

Query Parameters

universe?string
Default"crypto"
Value in"crypto"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v3/clusters"
{
  "data": [
    {
      "id": "cl_defi",
      "name": "DeFi researchers",
      "description": "Protocol analysts and yield researchers.",
      "universe": "crypto"
    }
  ],
  "meta": {}
}
{
  "code": "invalid_request",
  "message": "minTrend must be numeric",
  "details": {
    "fields": [
      "minTrend"
    ]
  }
}

{
  "code": "credential_required",
  "message": "Provide an API key via the x-api-key header."
}

{
  "code": "rate_limited",
  "message": "Minute limit reached.",
  "details": {
    "limit": 100,
    "window": "minute"
  }
}
{
  "code": "internal_error",
  "message": "Unexpected error."
}