> ## 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.

# getIncome

> Get income.



## OpenAPI

````yaml /openapi.yaml get /getIncome
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:
  /getIncome:
    get:
      tags:
        - Withdrawals
      summary: getIncome
      description: Get income.
      operationId: getIncome
      parameters:
        - $ref: '#/components/parameters/api_token'
        - name: interval
          in: query
          required: true
          schema:
            type: string
            description: Graph data intervals.
            enum:
              - year
              - month
              - week
              - day
        - name: start_date
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/start_date'
        - name: end_date
          in: query
          schema:
            $ref: '#/components/schemas/end_date'
      responses:
        '200':
          description: Request was successful.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    $ref: '#/components/schemas/success'
                  response:
                    type: array
                    description: >-
                      Endpoint-specific response payload, or an error message
                      when `success` is false.
                    items:
                      type: object
                      properties:
                        created_at:
                          $ref: '#/components/schemas/created_at'
                        referrer:
                          type: string
                          description: Referrer.
                        strategy_owner:
                          type: string
                          description: User ID of the strategy owner.
                        promotion:
                          type: string
                          description: Promotion.
              examples:
                '200':
                  value:
                    success: true
                    response:
                      - created_at: '2024-02-01T00:00:00.000Z'
                        referrer: '0'
                        strategy_owner: '700'
                        promotion: '10000'
        '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:
    start_date:
      type: string
      format: date-time
      description: Start date.
    end_date:
      type: string
      format: date-time
      description: End timestamp for the current period or range.
    success:
      type: boolean
      description: True when the request succeeded.
    created_at:
      type: string
      format: date-time
      description: Creation timestamp.
  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.

````