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

# Public profile of an arbitrary user (keyed by wallet address)

> Anonymous-readable profile for `/users/:address` deep-links (e.g. from the search dropdown). `:address` is the user's wallet (EOA); a vault address also resolves during the FE migration window. Returns username, verified flag, aggregate stats (volume, win rate, P&L, position counts). Cash, fees, favorites and KYC details are intentionally NOT exposed — those stay on `/api/me/*`. Addresses that don't resolve to a visible user (unknown / blocked / soft-deleted) are 404 to match the visibility contract used by /api/search.



## OpenAPI

````yaml /api-reference/openapi.json get /api/users/{address}
openapi: 3.1.0
info:
  title: PredictStreet API
  description: >-
    Client-facing HTTP API for the PredictStreet prediction-market platform.
    **Partner kinds.** Every authenticated endpoint resolves a request's
    *effective wallet* from the partner row. `single_wallet` partners bind to
    one `associatedWallet` set at creation. `multi_wallet` partners declare the
    actor on every request via an `X-User-Wallet: 0x<40-hex>` header. See the
    [Partner kinds](/auth/api-keys#partner-kinds) doc for the full contract.
  version: '2026-06-16'
  contact:
    name: PredictStreet partners
    email: partners@predictstreet.com
servers:
  - url: https://core.api.dev.predictstreet.sde.adifoundation.ai
    description: Testnet (partner integrator API — final domain TBD)
security: []
tags:
  - name: Deposits
    description: >-
      Gasless USDC deposit relay - submit a signed EIP-2612 permit and the
      platform broadcasts the on-chain deposit for you (no gas).
  - name: Events
    description: >-
      Polymarket-style event grouping with football metadata (group, stage,
      teams, tags).
  - name: Tags
    description: Curated tag taxonomy used to filter events.
  - name: Markets
    description: 'Public market data: list, detail, orderbook, trades, OHLC.'
  - name: Crypto
    description: >-
      Crypto price markets: the underlying-asset price curve and Up/Down series
      navigation. The markets themselves are ordinary binary markets — list them
      through /api/markets and /api/events.
  - name: Orders
    description: >-
      Signed-order place / cancel / read. Requires `X-Api-Key` with
      `orders:read` / `orders:write` scope; every write additionally requires an
      EIP-712 signature over the order.
  - name: Portfolio
    description: >-
      Balances, positions, trades, fees, vault info for the key's
      `associatedWallet`. Requires `X-Api-Key` with `portfolio:read` scope.
  - name: Matches
    description: >-
      A match groups several events into one fixture/card (1X2 + first-scorer +
      over-under under one matchup).
  - name: Vault
    description: >-
      Backend co-signatures for ERC-1155 split / merge, and recovery for
      off-chain locks when the corresponding chain tx never confirmed. Requires
      `X-Api-Key` with `vault:write` scope plus an EIP-712 signature over the
      operation.
  - name: Leaderboard
    description: Public ranked leaderboard across PnL / volume buckets.
  - name: Search
    description: Global search across users, events, and matches.
  - name: Withdrawal Security
    description: >-
      Self-service withdrawal 2FA (TOTP) and withdrawal-address whitelist. Same
      endpoints serve the web app (user sessions) and API-key integrators.
      Mutations need `vault:write`, reads `portfolio:read`. Both are opt-in per
      wallet and only gate withdrawals once the platform enables
      withdrawal-security enforcement.
  - name: Platform
    description: >-
      Public platform state: the contract registry, the platform fee
      configuration, the platform freeze flag and active notices. No
      authentication.
paths:
  /api/users/{address}:
    get:
      tags:
        - Public Profile
      summary: Public profile of an arbitrary user (keyed by wallet address)
      description: >-
        Anonymous-readable profile for `/users/:address` deep-links (e.g. from
        the search dropdown). `:address` is the user's wallet (EOA); a vault
        address also resolves during the FE migration window. Returns username,
        verified flag, aggregate stats (volume, win rate, P&L, position counts).
        Cash, fees, favorites and KYC details are intentionally NOT exposed —
        those stay on `/api/me/*`. Addresses that don't resolve to a visible
        user (unknown / blocked / soft-deleted) are 404 to match the visibility
        contract used by /api/search.
      operationId: PublicProfileController_overview
      parameters:
        - name: address
          required: true
          in: path
          description: >-
            0x-prefixed 40-hex address — wallet (preferred) or vault
            (transitional), case-insensitive.
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicProfileDto'
components:
  schemas:
    PublicProfileDto:
      type: object
      properties:
        walletAddress:
          type: string
          description: >-
            The user's wallet (EOA) address, EIP-55 checksummed — the public
            identity used by `/api/users/:address`.
        vaultAddress:
          type: string
          description: >-
            Deprecated: the user's vault address (lowercase, as stored), kept
            for back-compat during the FE migration to walletAddress.
        username:
          type: string
          nullable: true
        verified:
          type: boolean
          description: True when the user has cleared at least KYC tier 1.
        joinedAt:
          type: string
          description: ISO-8601 of account creation.
        stats:
          $ref: '#/components/schemas/PublicProfileStatsDto'
      required:
        - walletAddress
        - vaultAddress
        - username
        - verified
        - joinedAt
        - stats
    PublicProfileStatsDto:
      type: object
      properties:
        portfolioValue:
          type: string
          nullable: true
          description: >-
            USDC sum of open mark values; null when any open position lacks a
            current price.
        totalVolume:
          type: string
          description: Lifetime matched-trade notional, USDC.
        totalProfit:
          type: string
          nullable: true
          description: Realized + unrealized P&L, USDC.
        winRate:
          type: string
          nullable: true
          description: 0..1 decimal; null when no resolved positions yet.
        realizedPnl:
          type: string
          description: >-
            Wallet-wide realised PnL in USDC (decimal string). Sourced from the
            leaderboard event log so it matches the leaderboard rank.
        unrealizedPnl:
          type: string
          description: >-
            Wallet-wide unrealised PnL in USDC. Best-effort sum across
            reconstructible open positions.
        realizedPnlPercent:
          type: string
          nullable: true
          description: >-
            Realised PnL as percent of cost basis already sold/merged out. Null
            when nothing sold yet.
        unrealizedPnlPercent:
          type: string
          nullable: true
          description: >-
            Unrealised PnL as percent of cost basis of currently held open
            positions.
        biggestWin:
          type: string
          nullable: true
          description: >-
            Largest single winning market resolution, lifetime, whole-wallet,
            USDC decimal string. Null when the wallet has never won a
            resolution.
        roiPercent:
          type: string
          nullable: true
          description: >-
            Lifetime ROI: totalProfit ÷ Σ cost basis ever put at risk (open +
            resolved + sold), as a percent. Null when nothing has ever been put
            at risk.
        openPositions:
          type: number
        wonPositions:
          type: number
        lostPositions:
          type: number
        voidedPositions:
          type: number
          description: >-
            VOIDED markets the user held — equal-share refunds, distinct bucket
            from wins/losses. Optional during rollout; older clients that don't
            render the VOID tab can safely ignore it.
        profileViews:
          type: number
          description: Raw profile view count.
      required:
        - portfolioValue
        - totalVolume
        - totalProfit
        - winRate
        - realizedPnl
        - unrealizedPnl
        - realizedPnlPercent
        - unrealizedPnlPercent
        - biggestWin
        - roiPercent
        - openPositions
        - wonPositions
        - lostPositions
        - profileViews

````

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