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

# getBotInfo

> Get bot info.



## OpenAPI

````yaml /openapi.yaml get /getBotInfo
openapi: 3.1.0
info:
  title: AlphaInsider
  version: '1.0'
  description: >-
    The official API and websocket documentation for
    [AlphaInsider.com](https://alphainsider.com/)
servers:
  - url: https://alphainsider.com/api
security: []
tags:
  - name: Introduction
  - name: Authentication
  - name: Users
  - name: Strategies
  - name: Subscriptions
  - name: Payments
  - name: Withdrawals
  - name: Timelines
  - name: Stocks
  - name: Trades
  - name: Webhooks
  - name: Bots
  - name: Websockets
paths:
  /getBotInfo:
    get:
      tags:
        - Bots
      summary: getBotInfo
      description: Get bot info.
      operationId: getBotInfo
      parameters:
        - $ref: '#/components/parameters/api_token'
        - name: bot_id
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/bot_id'
      responses:
        '200':
          description: Request was successful.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    $ref: '#/components/schemas/success'
                  response:
                    type: object
                    description: >-
                      Endpoint-specific response payload, or an error message
                      when `success` is false.
                    properties:
                      bot_id:
                        $ref: '#/components/schemas/bot_id'
                      user_id:
                        $ref: '#/components/schemas/user_id'
                      broker:
                        type: string
                        enum:
                          - hyperliquid
                          - bitfinex
                          - binance
                          - alpaca
                        description: Broker used by the bot.
                      type:
                        type: string
                        enum:
                          - cryptocurrency
                          - stock
                        description: Type or category for this object.
                      live:
                        type: boolean
                        description: Whether the broker account is live rather than paper.
                      account_id:
                        type: string
                        description: Broker account identifier.
                      broker_status:
                        type: string
                        description: Broker connection status.
                      broker_details:
                        type: object
                        description: >-
                          Broker account details returned by the broker
                          integration.
                        properties:
                          margin_type:
                            type: string
                            description: Broker margin type.
                          value:
                            type: string
                            description: Broker account value.
                          buying_power:
                            type: string
                            description: Broker buying power.
                          min_total:
                            type: string
                            description: Minimum order total for the broker account.
                          max_leverage:
                            type: string
                            description: Maximum broker leverage.
                          initial_buying_power_percent:
                            type: string
                            description: >-
                              Initial buying-power percentage reserved for bot
                              execution.
                          positions:
                            type: array
                            description: Nested position records.
                            items:
                              type: object
                              properties:
                                broker_stock_id:
                                  type: string
                                  description: Broker-specific symbol or stock identifier.
                                amount:
                                  type: string
                                  description: Amount.
                                bid:
                                  type: string
                                  description: Current bid price.
                                ask:
                                  type: string
                                  description: Current ask price.
              examples:
                '200':
                  value:
                    success: true
                    response:
                      bot_id: h_zZfeqsX9o8hgB8DVc0P
                      user_id: user_1
                      broker: alpaca
                      type: stock
                      live: false
                      account_id: AAABBBCCC
                      broker_status: valid
                      broker_details:
                        margin_type: reg_t
                        value: '93003.68'
                        buying_power: '186007.36'
                        min_total: '1'
                        max_leverage: '2'
                        initial_buying_power_percent: '0.95'
                        positions:
                          - broker_stock_id: COIN
                            amount: '105.16414'
                            bid: '338'
                            ask: '356.99'
                          - broker_stock_id: INTC
                            amount: '-617.19069'
                            bid: '34.08'
                            ask: '0'
                          - broker_stock_id: PLTR
                            amount: '156.39204'
                            bid: '179.7'
                            ask: '179.76'
                          - broker_stock_id: TSLA
                            amount: '12.45853'
                            bid: '405.26'
                            ask: '0'
                          - broker_stock_id: XYZ
                            amount: '348.94207'
                            bid: '73.28'
                            ask: '76.81'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
components:
  parameters:
    api_token:
      in: header
      name: Authorization
      description: User API token.
      required: true
      schema:
        type: string
        format: JWT
  schemas:
    bot_id:
      type: string
      description: AlphaInsider bot identifier.
    success:
      type: boolean
      description: True when the request succeeded.
    user_id:
      type: string
      description: AlphaInsider user identifier.
  responses:
    '400':
      description: Request failed.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                description: False when the request failed.
              response:
                type: string
                description: Error message.
          examples:
            '400':
              value:
                success: false
                response: Request failed.
    '401':
      description: Authentication failed.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                description: False when the request failed.
              response:
                type: string
                description: Error message.
          examples:
            '401':
              value:
                success: false
                response: Authentication failed.

````