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

# Per-EOA rolling deposit caps + current usage

> Read-only mirror of `DepositLimitRegistry.{getEffectiveLimits,getUsage,isInitialized}` for the authenticated wallet. All amount fields are decimal USDC strings. `windowResetsAt.<window>` is `windowStart + WINDOW` while the recorded window is open, or `null` once it has expired (the registry zeroes `used` lazily on the next deposit, so a stale window is reported as `used = 0` and `null` reset).



## OpenAPI

````yaml /api-reference/openapi.json get /api/me/deposit-limits
openapi: 3.1.0
info:
  title: PredictStreet core-api
  description: >-
    Client-facing HTTP gateway 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-04-25'
  contact:
    name: PredictStreet partners
    email: partners@predictstreet.com
servers:
  - url: https://core-api.adipredictstreet.com
    description: Production — replace with the API host issued at partner onboarding.
security: []
tags:
  - 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: 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: >-
      admin.matches aggregate — 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.
paths:
  /api/me/deposit-limits:
    get:
      tags:
        - Portfolio
      summary: Per-EOA rolling deposit caps + current usage
      description: >-
        Read-only mirror of
        `DepositLimitRegistry.{getEffectiveLimits,getUsage,isInitialized}` for
        the authenticated wallet. All amount fields are decimal USDC strings.
        `windowResetsAt.<window>` is `windowStart + WINDOW` while the recorded
        window is open, or `null` once it has expired (the registry zeroes
        `used` lazily on the next deposit, so a stale window is reported as
        `used = 0` and `null` reset).
      operationId: PortfolioController_depositLimits
      parameters:
        - $ref: '#/components/parameters/UserWalletHeader'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DepositLimitsRespDto'
                type: object
                properties:
                  walletAddress:
                    type: string
                    description: Authenticated wallet (lowercase 0x-hex).
                  initialized:
                    type: boolean
                    description: >-
                      Whether `DepositLimitRegistry` has been initialised for
                      this wallet on-chain. `false` means the platform's
                      auto-init pass has not landed yet — caps are reported but
                      `vault.depositERC20` will revert with `NotInitialized()`
                      until the back-office init tx mines.
                  caps:
                    $ref: '#/components/schemas/DepositLimitWindows'
                  used:
                    $ref: '#/components/schemas/DepositLimitWindows'
                  remaining:
                    $ref: '#/components/schemas/DepositLimitWindows'
                  windowResetsAt:
                    type: object
                    properties:
                      daily:
                        type: string
                        format: date-time
                        nullable: true
                      weekly:
                        type: string
                        format: date-time
                        nullable: true
                      monthly:
                        type: string
                        format: date-time
                        nullable: true
      security:
        - ApiKeyAuth:
            - portfolio:read
components:
  parameters:
    UserWalletHeader:
      name: X-User-Wallet
      in: header
      required: false
      description: >-
        **Required for `multi_wallet` partners on every authenticated request;
        ignored for `single_wallet`.** Declares the acting end-user wallet for
        this request — drives KYC checks, balances/positions/orders attribution,
        rate-limit buckets, and audit. Lower-cased server-side. Missing on a
        multi_wallet key → 401 `api_key_user_wallet_required`; malformed → 401
        `api_key_user_wallet_invalid`. The on-chain `CTFExchange`/`Vault`
        contracts still verify EIP-712 signer ↔ vault binding, so loosening
        API-layer attribution is safe by construction.
      schema:
        $ref: '#/components/schemas/EthereumAddress'
      example: '0x1234567890abcdef1234567890abcdef12345678'
  schemas:
    DepositLimitsRespDto:
      type: object
      properties:
        walletAddress:
          type: string
          description: Authenticated wallet (lowercase 0x-hex).
        initialized:
          type: boolean
          description: >-
            Whether `DepositLimitRegistry` has been initialised for this wallet
            on-chain. `false` means the auto-init pass has not landed yet — caps
            are reported but `vault.depositERC20` will revert with
            `NotInitialized()` until the back-office init tx mines (see
            /concepts/deposits/limits).
        caps:
          description: Per-window cap (decimal USDC strings).
          allOf:
            - $ref: '#/components/schemas/DepositLimitWindowsDto'
        used:
          description: Sum of deposits inside the current rolling window (decimal USDC).
          allOf:
            - $ref: '#/components/schemas/DepositLimitWindowsDto'
        remaining:
          description: Headroom under each cap = cap - used (clamped at 0).
          allOf:
            - $ref: '#/components/schemas/DepositLimitWindowsDto'
        windowResetsAt:
          $ref: '#/components/schemas/DepositLimitWindowResetsDto'
      required:
        - walletAddress
        - initialized
        - caps
        - used
        - remaining
        - windowResetsAt
    EthereumAddress:
      type: string
      pattern: ^0x[a-fA-F0-9]{40}$
      example: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb3'
    DepositLimitWindowsDto:
      type: object
      properties:
        daily:
          type: string
          description: Daily window value, decimal USDC string.
        weekly:
          type: string
          description: Weekly window value, decimal USDC string.
        monthly:
          type: string
          description: Monthly window value, decimal USDC string.
      required:
        - daily
        - weekly
        - monthly
    DepositLimitWindowResetsDto:
      type: object
      properties:
        daily:
          type: object
          nullable: true
          description: >-
            ISO-8601 — when the daily window rolls. `null` means the recorded
            window has already expired; the next deposit will start a fresh
            window.
        weekly:
          type: object
          nullable: true
        monthly:
          type: object
          nullable: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        Partner / integrator key — format `ps_live_<keyId>_<secret>`. Issued by
        PredictStreet ops on request; never self-service. Never ship to a
        browser. `multi_wallet` partners must additionally send `X-User-Wallet:
        0x<40-hex>` on every authenticated request to declare the acting wallet.
        See the [API keys guide](/auth/api-keys) for scope taxonomy, partner
        kinds, rate limits, and rotation procedure.

````