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

# Rug Predict

> Analyze bundler patterns and return a short, trader-facing rug-style AI explanation.

Combines bundler analytics with a concise summary, reasons, and recommendations.


## OpenAPI

````yaml POST /v1/token/rug
openapi: 3.0.3
info:
  title: NovaShield Security Engine
  description: >-
    Enterprise-grade security scanning API for Solana. Analyze transactions,
    tokens, addresses, and dApps before user interaction.
  version: 3.0.0
  contact:
    name: NovaShield
    url: https://nshield.org
servers:
  - url: https://api.novashield.so
    description: Production
  - url: https://sapi.novashield.so
    description: Staging
security: []
tags:
  - name: Security Scanning
    description: >-
      Core security scanning endpoints for transactions, tokens, addresses, and
      dApps
paths:
  /v1/token/rug:
    post:
      tags:
        - Security Scanning
      summary: Rug Predict
      description: >-
        Analyze bundler patterns and return a short rug-pull style AI
        explanation.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScanRugRequest'
      responses:
        '200':
          description: Bundle + rug-style analysis complete
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanBundleRugResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    ScanRugRequest:
      type: object
      required:
        - chain
        - mint
      properties:
        chain:
          type: string
          enum:
            - solana
        mint:
          type: string
          description: Token mint address to analyze
    ScanBundleRugResponse:
      type: object
      properties:
        mint:
          type: string
        period:
          type: string
          enum:
            - launch
            - recent
        analysis:
          $ref: '#/components/schemas/BundleAnalysis'
        rug:
          $ref: '#/components/schemas/BundleRugSummary'
    BundleAnalysis:
      type: object
      properties:
        bundlerScore:
          type: integer
          description: 0-100, higher means more coordinated/botted
        riskLevel:
          type: string
          enum:
            - LOW
            - MEDIUM
            - HIGH
            - CRITICAL
        metrics:
          type: object
          properties:
            timingCluster:
              type: number
            walletSimilarity:
              type: number
            sizePatterns:
              type: number
            distribution:
              type: number
        details:
          type: object
          properties:
            totalTransactions:
              type: integer
            uniqueWallets:
              type: integer
            suspiciousWallets:
              type: integer
            analysisPeriod:
              type: string
        verdict:
          type: string
        concerns:
          type: array
          items:
            type: string
        recommendations:
          type: array
          items:
            type: string
        topBuyers:
          type: array
          items:
            type: object
            properties:
              wallet:
                type: string
              totalAmount:
                type: number
              supplyPercentage:
                type: number
              transactionCount:
                type: integer
              isDevRelated:
                type: boolean
    BundleRugSummary:
      type: object
      properties:
        riskScore:
          type: number
          description: 0-100, higher = higher rug-style risk
        riskLevel:
          type: string
          enum:
            - LOW
            - MEDIUM
            - HIGH
            - CRITICAL
        verdict:
          type: string
        canTrade:
          type: boolean
        isHighRisk:
          type: boolean
        summary:
          type: string
          description: 1-3 sentence trader-facing explanation
        reasons:
          type: array
          items:
            type: string
        recommendations:
          type: array
          items:
            type: string
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
              example: INVALID_REQUEST
            message:
              type: string
              example: Invalid request parameters
            details:
              type: string
        timestamp:
          type: string
          format: date-time
  responses:
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'

````