# Token intelligence

- Method: `GET`
- Path: `/token/{id}/intelligence`
- Tier: Pro
- HTML docs: https://docs.ruma.fun/reference/get-token-id-intelligence/
- Interactive docs: https://docs.ruma.fun/#endpoint=get-token-id-intelligence

## Description

Paginated intelligence for the token. Filter by time range, tags, order.

## cURL Example

```bash
curl --request GET \
  --url 'https://api.ruma.fun/api/v1/public/token/bitcoin/intelligence' \
  --header 'X-API-Key: YOUR_API_KEY'
```

## Path Parameters

- `id` (string, required): Token identifier. Accepts internal token_id (integer) or coingecko_id (string, e.g. bitcoin).

## Query Parameters

- `limit` (integer, optional): Maximum number of items to return (default and max may vary by endpoint).
- `offset` (integer, optional): Number of items to skip for pagination (use with limit).
- `startTimeAfter` (string (date-time), optional): Return insights that start after this ISO 8601 date-time.
- `startTimeBefore` (string (date-time), optional): Return insights that start before this ISO 8601 date-time.
- `updatedAtAfter` (string (date-time), optional): Return insights last updated after this ISO 8601 date-time.
- `updatedAtBefore` (string (date-time), optional): Return insights last updated before this ISO 8601 date-time.
- `tags` (string, optional): Filter insights by tags (comma-separated; include only insights with any of these tags).
- `excludeTags` (string, optional): Exclude insights that have any of these tags (comma-separated).
- `orderBy` (string, optional): Sort order for insights (e.g. start_time_asc, start_time_desc, updated_at_desc).

## Response

OK

- `insights` (array<object>): Paginated intelligence records related to the token.
- `insights[].accounts` (array<object>): No description provided.
- `insights[].accounts[].author_id` (integer (int64)): Internal Ruma author identifier for this account.
- `insights[].accounts[].avatar_url` (string): URL of the account’s avatar image.
- `insights[].accounts[].display_name` (string): Display name of the author account.
- `insights[].accounts[].handle` (string): No description provided.
- `insights[].accounts[].screen_name` (string): Screen name or handle on the source platform.
- `insights[].accounts[].source` (string): Origin/source of the insight data.
- `insights[].accounts[].source_user_id` (string): Identifier for the author on the source platform.
- `insights[].category` (string): No description provided.
- `insights[].embedding` (array<number (float)>): Numeric embedding vector for semantic similarity search.
- `insights[].enriched_related_posts` (array<object>): Posts related to this insight with additional enrichment.
- `insights[].enriched_related_posts[].allHandles` (array<string>): No description provided.
- `insights[].enriched_related_posts[].allProjects` (array<object>): No description provided.
- `insights[].enriched_related_posts[].callPerformance` (object): No description provided.
- `insights[].enriched_related_posts[].permalink` (string): No description provided.
- `insights[].enriched_related_posts[].postId` (string): No description provided.
- `insights[].enriched_related_posts[].postType` (string): No description provided.
- `insights[].enriched_related_posts[].postedAt` (string (date-time)): No description provided.
- `insights[].enriched_related_posts[].project` (object): No description provided.
- `insights[].enriched_related_posts[].relatedHandle` (string): No description provided.
- `insights[].enriched_related_posts[].relatedToken` (integer (int64)): No description provided.
- `insights[].enriched_related_posts[].sentimentScore` (number (double)): No description provided.
- `insights[].enriched_related_posts[].source` (string): Origin/source of the insight data.
- `insights[].enriched_related_posts[].tags` (array<object>): Tag selectors applied to the request.
- `insights[].enriched_related_posts[].tweet` (object): No description provided.
- `insights[].enriched_related_posts[].user` (object): No description provided.
- `insights[].headline` (string): No description provided.
- `insights[].id` (integer (int64)): No description provided.
- `insights[].importance_score` (integer): Relative importance score for the insight (higher is more important).
- `insights[].primary_subject` (object): No description provided.
- `insights[].primary_subject.account` (object): No description provided.
- `insights[].primary_subject.account.author_id` (integer (int64)): Internal Ruma author identifier for this account.
- `insights[].primary_subject.account.avatar_url` (string): URL of the account’s avatar image.
- `insights[].primary_subject.account.display_name` (string): Display name of the author account.
- `insights[].primary_subject.account.handle` (string): No description provided.
- `insights[].primary_subject.account.screen_name` (string): Screen name or handle on the source platform.
- `insights[].primary_subject.account.source` (string): Origin/source of the insight data.
- `insights[].primary_subject.account.source_user_id` (string): Identifier for the author on the source platform.
- `insights[].primary_subject.project` (object): No description provided.
- `insights[].primary_subject.project.handle` (string): No description provided.
- `insights[].primary_subject.project.image_url` (string): Project or token logo URL.
- `insights[].primary_subject.project.internal_id` (integer (int64)): Internal Ruma identifier for the account or project.
- `insights[].primary_subject.project.name` (string): Display name.
- `insights[].primary_subject.project.symbol` (string): Token symbol.
- `insights[].primary_subject.type` (string): No description provided.
- `insights[].projects` (array<object>): No description provided.
- `insights[].projects[].handle` (string): No description provided.
- `insights[].projects[].image_url` (string): Project or token logo URL.
- `insights[].projects[].internal_id` (integer (int64)): Internal Ruma identifier for the account or project.
- `insights[].projects[].name` (string): Display name.
- `insights[].projects[].symbol` (string): Token symbol.
- `insights[].sentiment` (integer): No description provided.
- `insights[].start_time` (string (date-time)): When the insight became active or relevant (UTC).
- `insights[].summary` (string): Summary output for the endpoint.
- `insights[].tags` (array<string>): Tag selectors applied to the request.
- `insights[].updated_at` (string (date-time)): Last time the insight record was updated (UTC).

Media type: `application/json`

## JSON Response

```json
{
  "insights": [
    {
      "accounts": [
        {
          "author_id": 0,
          "avatar_url": "string",
          "display_name": "string",
          "handle": "string",
          "screen_name": "string",
          "source": "string",
          "source_user_id": "string"
        }
      ],
      "category": "string",
      "embedding": [
        0
      ],
      "enriched_related_posts": [
        {
          "allHandles": [],
          "allProjects": [],
          "callPerformance": {},
          "permalink": "string",
          "postId": "string",
          "postType": "string",
          "postedAt": "2026-01-15T12:00:00Z",
          "project": {},
          "relatedHandle": "string",
          "relatedToken": 0,
          "sentimentScore": 0,
          "source": "string",
          "tags": [],
          "tweet": {},
          "user": {}
        }
      ],
      "headline": "string",
      "id": 0,
      "importance_score": 0,
      "primary_subject": {
        "account": {
          "author_id": 0,
          "avatar_url": "string",
          "display_name": "string",
          "handle": "string",
          "screen_name": "string",
          "source": "string",
          "source_user_id": "string"
        },
        "project": {
          "handle": "string",
          "image_url": "string",
          "internal_id": 0,
          "name": "string",
          "symbol": "string"
        },
        "type": "string"
      },
      "projects": [
        {
          "handle": "string",
          "image_url": "string",
          "internal_id": 0,
          "name": "string",
          "symbol": "string"
        }
      ],
      "sentiment": 0,
      "start_time": "2026-01-15T12:00:00Z",
      "summary": "string",
      "tags": [
        "string"
      ],
      "updated_at": "2026-01-15T12:00:00Z"
    }
  ]
}
```