AIXBT Docs

Reference

Get an Intel item

View as Markdown
GET
/v3/intel/{id}

Intel detail with the activity trail and cluster composition. The history boundary is enforced against the intel's own recency (reinforcedAt, falling back to detectedAt).

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

Path Parameters

id*string

Query Parameters

activity?string
Default"all"
Value in"all" | "observations" | "none"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v3/intel/string"
{
  "data": {
    "id": "6890aa000000000000000001",
    "headline": "Mainnet v2 date confirmed",
    "description": "ExampleChain confirmed the v2 mainnet date for September 3rd with a public changelog entry.",
    "grade": "polished",
    "project": {
      "id": "665f0a2b1c9d440000a1b2c3",
      "slug": "examplechain",
      "name": "ExampleChain"
    },
    "category": "product-launch",
    "clusters": [
      {
        "id": "cl_defi",
        "name": "DeFi researchers"
      }
    ],
    "observationCount": 9,
    "hasOfficialSource": true,
    "citations": [
      "https://blog.example.chain/v2-mainnet"
    ],
    "sentiment": {
      "value": "positive"
    },
    "detectedAt": "2026-08-04T21:14:00Z",
    "reinforcedAt": "2026-08-05T03:40:00Z",
    "activity": [
      {
        "action": "observation",
        "detectedAt": "2026-08-04T21:14:00Z",
        "occurredAt": "2026-08-04T21:14:00Z",
        "eventTime": {
          "status": "instant",
          "at": "2026-09-03T00:00:00Z",
          "precision": "day",
          "relationToSource": "future"
        },
        "headline": "First sighting",
        "source": {
          "url": "https://x.com/someone/status/1",
          "official": false
        },
        "sentiment": {
          "value": "positive"
        }
      },
      {
        "action": "official_statement",
        "detectedAt": "2026-08-04T22:03:00Z",
        "occurredAt": "2026-08-04T22:03:00Z",
        "eventTime": {
          "status": "unknown",
          "reason": "ambiguous"
        },
        "source": {
          "url": "https://blog.example.chain/v2-mainnet",
          "official": true
        }
      }
    ],
    "clusterComposition": [
      {
        "cluster": {
          "id": "cl_defi",
          "name": "DeFi researchers"
        },
        "percentage": 62.5
      },
      {
        "cluster": {
          "id": "cl_other",
          "name": "Other"
        },
        "percentage": 37.5
      }
    ]
  },
  "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": "entitlement_required",
  "message": "This resource requires the topic-reports entitlement.",
  "details": {
    "entitlement": "topic-reports"
  }
}

{
  "code": "not_found",
  "message": "No Project matches that locator.",
  "details": {
    "subject": {
      "type": "project",
      "locator": "examplechain"
    }
  }
}

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