> ## Documentation Index
> Fetch the complete documentation index at: https://partners.centaur.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List traders



## OpenAPI

````yaml /openapi.json get /api/v1/traders
openapi: 3.1.0
info:
  title: Centaur API
  version: 1.0.0
  description: >-
    Public, read-only API for Centaur's data over REST with a companion MCP
    surface.
servers:
  - url: https://partners.centaur.io
    description: Current service base URL
security: []
tags:
  - name: System
    description: Health and service metadata endpoints.
  - name: Discovery
    description: Read-only trader and asset directory discovery endpoints.
  - name: Events
    description: >-
      Historical trade-event reads with source, trader, asset, and position
      context.
  - name: Messages
    description: >-
      Read-only access to source messages by message timestamp or Source Message
      ID.
  - name: Channel Summaries
    description: Generated channel narrative summaries selected by Source Window overlap.
  - name: Aggregate Summaries
    description: >-
      Generated aggregate narrative summaries selected by Aggregate Window
      overlap.
  - name: Positions
    description: Read-only position history and open-position live state reads.
  - name: Stats
    description: Read-only aggregate trader and asset stats.
externalDocs:
  description: Canonical Centaur API documentation
  url: https://partners.centaur.io/docs
paths:
  /api/v1/traders:
    get:
      tags:
        - Discovery
      summary: List traders
      operationId: listTraders
      parameters:
        - schema:
            type: string
            minLength: 1
            description: Case-insensitive partial match against trader name or slug.
          required: false
          description: Case-insensitive partial match against trader name or slug.
          name: search
          in: query
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
              - type: array
                items:
                  type: number
            description: Filter to specific trader IDs.
          required: false
          description: Filter to specific trader IDs.
          name: traderIds
          in: query
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
              - type: array
                items:
                  type: number
            description: Filter to traders with eligible positions on specific asset IDs.
          required: false
          description: Filter to traders with eligible positions on specific asset IDs.
          name: assetIds
          in: query
        - schema:
            anyOf:
              - anyOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                  - type: array
                    items:
                      type: number
              - type: array
                items:
                  $ref: '#/components/schemas/SourcePlatform'
            description: Filter to traders whose source platform is `TELEGRAM` or `X`.
          required: false
          description: Filter to traders whose source platform is `TELEGRAM` or `X`.
          name: sourcePlatforms
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            default: 3
            description: >-
              Minimum tradeCount required for a trader to appear in discovery.
              tradeCount is the eligible visible position count after asset and
              position-open time filters. Defaults to 3; pass 0 for the full
              visible directory.
          required: false
          description: >-
            Minimum tradeCount required for a trader to appear in discovery.
            tradeCount is the eligible visible position count after asset and
            position-open time filters. Defaults to 3; pass 0 for the full
            visible directory.
          name: minTrades
          in: query
        - schema:
            type: string
            format: date-time
            description: >-
              Inclusive ISO-8601 lower bound on position open time for trader
              discovery tradeCount and minTrades. This does not compute
              performance metrics; use trader stats for performance.
          required: false
          description: >-
            Inclusive ISO-8601 lower bound on position open time for trader
            discovery tradeCount and minTrades. This does not compute
            performance metrics; use trader stats for performance.
          name: startTime
          in: query
        - schema:
            type: string
            format: date-time
            description: >-
              Inclusive ISO-8601 upper bound on position open time for trader
              discovery tradeCount and minTrades. This does not compute
              performance metrics; use trader stats for performance.
          required: false
          description: >-
            Inclusive ISO-8601 upper bound on position open time for trader
            discovery tradeCount and minTrades. This does not compute
            performance metrics; use trader stats for performance.
          name: endTime
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            description: Maximum number of rows to return.
          required: false
          description: Maximum number of rows to return.
          name: limit
          in: query
        - schema:
            type: string
            minLength: 1
            description: Forward pagination cursor from `meta.nextCursor`.
          required: false
          description: Forward pagination cursor from `meta.nextCursor`.
          name: cursor
          in: query
      responses:
        '200':
          description: Paginated list of traders
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/TradersResponseData'
                  requestId:
                    type: string
                    example: c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8
                required:
                  - success
                  - data
                  - requestId
        '400':
          description: Invalid cursor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              example:
                success: false
                error:
                  code: INVALID_CURSOR
                  message: Malformed cursor
                requestId: c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              example:
                success: false
                error:
                  code: UNAUTHORIZED
                  message: Unauthorized
                requestId: c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              example:
                success: false
                error:
                  code: FORBIDDEN
                  message: Forbidden
                requestId: c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '503':
          description: Authentication service temporarily unavailable
          headers:
            Retry-After:
              description: Seconds to wait before retrying authentication
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              example:
                success: false
                error:
                  code: AUTHENTICATION_UNAVAILABLE
                  message: Authentication is temporarily unavailable
                requestId: c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8
      security:
        - ApiKeyAuth: []
components:
  schemas:
    SourcePlatform:
      type: string
      enum:
        - TELEGRAM
        - X
    TradersResponseData:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/TraderSummary'
        meta:
          type: object
          properties:
            hasMore:
              type: boolean
            nextCursor:
              type: string
              nullable: true
          required:
            - hasMore
            - nextCursor
      required:
        - results
        - meta
    ErrorEnvelope:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          $ref: '#/components/schemas/Error'
        requestId:
          type: string
          example: c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8
      required:
        - success
        - error
        - requestId
    TraderSummary:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        slug:
          type: string
          nullable: true
        avatarUrl:
          type: string
          nullable: true
        tradeCount:
          type: integer
          description: >-
            Number of eligible visible positions for this trader after discovery
            asset and position-open time filters.
        source:
          allOf:
            - $ref: '#/components/schemas/SourceIdentity'
            - nullable: true
      required:
        - id
        - name
        - slug
        - avatarUrl
        - tradeCount
        - source
    Error:
      type: object
      properties:
        code:
          type: string
          description: Stable machine-readable error code.
          example: UNAUTHORIZED
        message:
          type: string
          description: Human-readable explanation for the failure.
          example: Unauthorized
        details:
          nullable: true
          description: Optional structured details for validation or input failures.
      required:
        - code
        - message
    SourceIdentity:
      type: object
      properties:
        platform:
          $ref: '#/components/schemas/SourcePlatform'
        sourceIdentityId:
          type: string
          description: >-
            Opaque platform-scoped source identity ID for the source account or
            channel.
        displayName:
          type: string
          nullable: true
          description: Display name for the source account or channel when available.
        handle:
          type: string
          nullable: true
          description: Public source handle when available.
        avatarUrl:
          type: string
          nullable: true
          description: Source account or channel avatar URL when available.
        profileUrl:
          type: string
          nullable: true
          description: Original source account or channel URL when available.
        audienceCount:
          type: integer
          nullable: true
          description: Follower or subscriber count when available.
      required:
        - platform
        - sourceIdentityId
        - displayName
        - handle
        - avatarUrl
        - profileUrl
        - audienceCount
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key issued by Centaur.
      x-default: <api-key>

````