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

# List positions

> Returns live open positions (mark-to-market). `status=closed` currently returns an empty set.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/portfolio/positions
openapi: 3.1.0
info:
  title: Carbon Copy API
  version: 2.0.0
  description: >-
    Programmatic access to Carbon Copy's Polymarket copy-trading platform.
    Follow traders, manage your portfolio, and automate your prediction market
    strategy.
  contact:
    name: Carbon Copy Support
    email: support@carboncopy.inc
    url: https://carboncopy.inc
servers:
  - url: https://carboncopy.inc
    description: Production
security: []
tags:
  - name: Health
    description: Service health and status.
  - name: Portfolio
    description: Portfolio summary, positions, trade history, and P&L.
  - name: Follow Management
    description: >-
      Follow, configure, and manage the traders you copy. All routes live under
      `/portfolio/traders`.
  - name: Trader Discovery
    description: Search and filter traders on the platform. Routes under `/traders`.
  - name: Orders
    description: Inspect orders placed by your copy-trading bot.
  - name: Markets
    description: Market data — prices and token info.
  - name: Account
    description: Your Carbon Copy account information.
paths:
  /api/v1/portfolio/positions:
    get:
      tags:
        - Portfolio
      summary: List positions
      description: >-
        Returns live open positions (mark-to-market). `status=closed` currently
        returns an empty set.
      operationId: getPortfolioPositions
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
        - name: since
          in: query
          description: Unix ms timestamp lower bound for position openedAt.
          schema:
            type: integer
        - name: until
          in: query
          description: Unix ms timestamp upper bound for position openedAt.
          schema:
            type: integer
        - name: status
          in: query
          description: Filter positions by status.
          schema:
            type: string
            enum:
              - open
              - closed
              - all
            default: open
        - name: fresh
          in: query
          description: Set to true to bypass cached positions fetch.
          schema:
            type: boolean
      responses:
        '200':
          description: Open positions snapshot (not cursor-paginated).
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        items:
                          $ref: '#/components/schemas/OpenPosition'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    OpenPosition:
      type: object
      required:
        - id
        - title
        - direction
        - shares
        - avgPrice
        - currentPrice
        - positionValue
        - pnl
        - pnlPercentage
        - openedAt
      properties:
        id:
          type: string
          example: 0x1234abcd...
        title:
          type: string
          example: Will BTC exceed $100k by end of 2025?
        eventSlug:
          type:
            - string
            - 'null'
          example: bitcoin-markets
        marketSlug:
          type:
            - string
            - 'null'
          example: will-btc-exceed-100k-by-end-of-2025
        direction:
          type: string
          enum:
            - 'YES'
            - 'NO'
        shares:
          type: number
          example: 12.5
        avgPrice:
          type: number
          description: Average entry price in cents.
          example: 47
        currentPrice:
          type: number
          description: Current mark price in cents.
          example: 52
        positionValue:
          type: number
          description: Current position value in USDC.
          example: 6.5
        pnl:
          type: number
          description: Current unrealized P&L in USDC.
          example: 0.62
        pnlPercentage:
          type: number
          description: Current unrealized P&L percentage.
          example: 9.5
        copiedFromWallet:
          type:
            - string
            - 'null'
          example: 0xAbCd1234...
        copiedFromName:
          type:
            - string
            - 'null'
          example: sharptrader
        openedAt:
          type: integer
          description: Unix timestamp (ms) when the position was opened.
          example: 1710000000000
    ResponseMeta:
      type: object
      properties:
        requestId:
          type: string
          description: Unique request identifier for debugging.
          example: cf7301af-0c1e-4354-85a8-9153db69ae6d
        timestamp:
          type: integer
          description: Server timestamp (Unix ms).
          example: 1741600000000
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - bad_request
                - unauthorized
                - forbidden
                - not_found
                - method_not_allowed
                - conflict
                - quota_exceeded
                - rate_limited
                - internal_error
            message:
              type: string
              description: Human-readable description of the error.
  responses:
    Unauthorized:
      description: Missing or invalid authentication credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: unauthorized
              message: Invalid or missing API key.
    Forbidden:
      description: Authenticated but insufficient permissions (wrong scope).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: forbidden
              message: This key does not have the required scope.
    RateLimited:
      description: Too many requests. Back off and retry.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: rate_limited
              message: Rate limit exceeded. Retry after 30 seconds.
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        API key in the format `cc_<64 hex characters>`. Obtain from the
        Dashboard under Settings → API Keys.

````