AIXBT Signals API

openapi: 3.2.0
info:
  title: AIXBT Public Signals API
  version: 2.0.0
  description: 'Documentation for the AIXBT public API (v2).


    Most endpoints require an API key via the `x-api-key` header. Current topics, the deprecated `/grounding` topics alias, and cluster, category, and chain metadata are public. Historical topic data and all project, intel, signal, and recipe endpoints require authentication.


    Self-serve accounts can retrieve a rolling 90 days of proprietary AIXBT history, reported in `meta.history`. The boundary applies to explicit date ranges, historical `at` snapshots, pagination, and by-ID retrieval; older requests return `403 HISTORY_WINDOW_EXCEEDED` with the same `meta.history`. Accounts with the `archive-history` entitlement are uncapped. Current Topics and published Reports are excluded, while price candles and project market metrics retain their endpoint-specific windows.


    For full usage instructions, authentication and example projects, visit the documentation: docs.aixbt.tech.'
security:
- ApiKeyAuth: []
tags:
- name: Signals
paths:
  /v2/signals:
    get:
      summary: List Signals (deprecated alias of /v2/intel)
      deprecated: true
      x-successor: /v2/intel
      description: '**Deprecated compatibility alias.** Signals were renamed to Intel.

        This route responds with the exact `GET /v2/intel` contract — same

        parameters, response shape, and errors — and adds `Deprecation` and

        `Link: successor-version` headers. Migrate to `/v2/intel`.'
      tags:
      - Signals
      responses:
        '200':
          description: Identical to the GET /v2/intel response
          content:
            application/json:
              schema:
                type: object
                description: See GET /v2/intel
        '400':
          description: Invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Missing API key or history window exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      operationId: getV2Signals
  /v2/signals/{id}:
    get:
      summary: Get Signal by ID (deprecated alias)
      deprecated: true
      x-successor: /v2/intel
      description: '**Deprecated compatibility alias.** Responds with the exact

        `GET /v2/intel/{id}` contract. Migrate to `/v2/intel/{id}`.'
      tags:
      - Signals
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Identical to the GET /v2/intel/{id} response
          content:
            application/json:
              schema:
                type: object
                description: See GET /v2/intel/{id}
        '400':
          description: Invalid intel ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Missing API key or history window exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Intel not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      operationId: getV2SignalsById
components:
  schemas:
    ApiError:
      type: object
      required:
      - error
      description: Error response. Middleware may include additional rate-limit or access metadata.
      properties:
        error:
          type: string
        message:
          type: string
        code:
          type: string
        status:
          type: integer
        data: {}
        meta:
          type: object
          additionalProperties: true
        details:
          type: object
          additionalProperties: true
        pagination:
          $ref: '#/components/schemas/Pagination'
        limitType:
          type: string
          enum:
          - minute
          - day
          description: Rate-limit window that was exhausted.
        retryAfterMs:
          type: integer
          minimum: 0
          description: Milliseconds until the exhausted window resets.
        limits:
          type: object
          required:
          - minute
          - day
          properties:
            minute:
              $ref: '#/components/schemas/RateLimitWindow'
            day:
              $ref: '#/components/schemas/RateLimitWindow'
        issues:
          type: array
          items:
            type: object
            required:
            - path
            - message
            properties:
              path:
                type: string
              message:
                type: string
      additionalProperties: true
    Pagination:
      type: object
      required:
      - page
      - limit
      - totalCount
      - hasMore
      properties:
        page:
          type: integer
          minimum: 1
        limit:
          type: integer
          minimum: 1
        totalCount:
          type: integer
          minimum: 0
        hasMore:
          type: boolean
    RateLimitWindow:
      type: object
      required:
      - limit
      - remaining
      - resetAt
      properties:
        limit:
          type: integer
          minimum: 0
        remaining:
          type: integer
          minimum: 0
        resetAt:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key to authorize requests