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

# Read the account



## OpenAPI

````yaml /partner-openapi.gen.json get /partner/account
openapi: 3.1.0
info:
  title: Circuit partner API
  version: '0.1'
servers:
  - url: https://api.circuit.org
security: []
paths:
  /partner/account:
    get:
      summary: Read the account
      operationId: readAccount
      parameters:
        - name: circuit-partner-version
          in: header
          required: true
          example: '0.1'
          schema:
            type: string
            const: '0.1'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  expiresAt:
                    $ref: '#/components/schemas/Timestamp'
                    description: >-
                      When this connection's permit ends; connect again before
                      then.
                  wallets:
                    type: array
                    items:
                      $ref: '#/components/schemas/PartnerWallet'
                  agents:
                    description: >-
                      The user's agents on the picked wallets and on paper
                      money, newest first.
                    type: array
                    items:
                      $ref: '#/components/schemas/PartnerAgent'
                required:
                  - expiresAt
                  - wallets
                  - agents
        default:
          description: Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerFailure'
      security:
        - permit: []
components:
  schemas:
    Timestamp:
      type: string
      format: date-time
    PartnerWallet:
      type: object
      properties:
        id:
          description: Starts with `wal_`.
          type: string
        name:
          type: string
        address:
          type: string
        valueUsd:
          description: Decimal USD, null when a holding couldn't be priced.
          type:
            - string
            - 'null'
        holdings:
          type: array
          items:
            $ref: '#/components/schemas/PartnerHolding'
      required:
        - id
        - name
        - address
        - holdings
    PartnerAgent:
      type: object
      properties:
        id:
          description: Starts with `agt_`.
          type: string
        name:
          type: string
        walletId:
          description: The picked wallet the agent trades; null on paper money.
          type:
            - string
            - 'null'
        state:
          description: '`running`, `actionNeeded` (see `message`) or `stopped`.'
          type: string
        message:
          type:
            - string
            - 'null'
        valueUsd:
          type:
            - string
            - 'null'
        pnlUsd:
          type:
            - string
            - 'null'
        startedAt:
          $ref: '#/components/schemas/Timestamp'
        controls:
          description: 'What your app may send now: `stop`, `runNow`.'
          type: array
          items:
            type: string
      required:
        - id
        - name
        - state
        - startedAt
        - controls
    PartnerFailure:
      description: 'A failed call: act on its HTTP status and show `error` to the user.'
      type: object
      properties:
        error:
          type: string
      required:
        - error
    PartnerHolding:
      type: object
      properties:
        id:
          description: Starts with `hld_`; stable for this holding in this wallet.
          type: string
        symbol:
          description: The asset alone, such as `BTC`; `amount`'s sign says long or short.
          type: string
        network:
          type: string
        kind:
          description: Such as `token`, `perp`, `prediction`, `supplied` or `borrowed`.
          type: string
        amount:
          description: A decimal string; negative for a short or a debt.
          type: string
        valueUsd:
          type:
            - string
            - 'null'
      required:
        - id
        - symbol
        - network
        - kind
        - amount
  securitySchemes:
    permit:
      type: http
      scheme: bearer
      description: The permit the user approved for your app.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.