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

# Get user profile

> Returns profile information for a user on the specified prediction market platform. Optionally includes trading metrics like volume, PnL, and ROI.



## OpenAPI

````yaml GET /v1/api/profile/info
openapi: 3.1.0
info:
  title: Dot Prediction API
  description: >-
    A unified API for accessing prediction market data across Kalshi,
    Polymarket, and Limitless.
  version: 1.0.0
servers:
  - url: https://api.dotprediction.io
security:
  - apiKey: []
paths:
  /v1/api/profile/info:
    get:
      tags:
        - Profiles
      summary: Get user profile
      description: >-
        Returns profile information for a user on the specified prediction
        market platform. Optionally includes trading metrics like volume, PnL,
        and ROI.
      operationId: getUserProfile
      parameters:
        - name: provider
          in: query
          required: true
          description: The prediction market platform.
          schema:
            type: string
            enum:
              - kalshi
              - polymarket
        - name: user
          in: query
          required: true
          description: The user identifier on the platform (username or address).
          schema:
            type: string
        - name: include_metrics
          in: query
          required: false
          description: Include trading metrics (volume, PnL, ROI, portfolio value).
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
      responses:
        '200':
          description: User profile data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserProfileResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    GetUserProfileResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            profile:
              $ref: '#/components/schemas/UserProfile'
            metrics:
              $ref: '#/components/schemas/ProfileMetrics'
        meta:
          type: object
          properties:
            request_time:
              type: integer
            platform:
              type: string
            data_freshness:
              type: string
              format: date-time
    UserProfile:
      type: object
      properties:
        platform:
          type: string
        user_id:
          type: string
        display_name:
          type: string
        profile_image:
          type: string
        description:
          type: string
        joined_at:
          type: string
          format: date-time
        follower_count:
          type: integer
        following_count:
          type: integer
        profile_view_count:
          type: integer
        metadata:
          type: object
          additionalProperties: true
    ProfileMetrics:
      type: object
      properties:
        volume:
          type: number
          description: Total trading volume.
        pnl:
          type: number
          description: Profit and loss.
        num_markets_traded:
          type: integer
          description: Number of markets traded.
        roi:
          type: number
          description: Return on investment.
        portfolio_value:
          type: number
          description: Current portfolio value.
        open_interest:
          type: number
          description: Open interest.
        metadata:
          type: object
          additionalProperties: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              description: HTTP status code.
            message:
              type: string
              description: Human-readable error message.
            resolution:
              type: string
              description: Suggested action to resolve the error.
            error_text:
              type: string
              description: Detailed error information.
  responses:
    BadRequest:
      description: Invalid request parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: Rate limit exceeded. Check the `Retry-After` header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authentication. Generate one via the dashboard or the
        `/v1/api/auth/api-keys` endpoint.

````