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

# Follow a trader

> Adds one of your traders to the list your organization follows, or updates the note. Repeating the call is safe. You can follow at most 100 traders.

## Example

```bash
curl -X PUT "https://api.hyperprop.com/platform/v1/organization/insights/watchlist/2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b" \
  -H "X-API-Key: hp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"note": "Consistent NQ scalper"}'
```

**Permissions:** requires **manage** access to "Traders & accounts".

**Access:** full-access API keys only (a read-only key gets `403 READ_ONLY_KEY`). Dashboard members need manage access to Traders & accounts.



## OpenAPI

````yaml https://api.hyperprop.com/platform/openapi.json put /v1/organization/insights/watchlist/{traderId}
openapi: 3.0.0
info:
  title: Hyperprop Platform API
  version: 1.0.0
  description: >-
    REST API for the Hyperprop Trading Platform — provision evaluation and
    funded trading accounts, manage traders and plans, react to account
    lifecycle events via signed webhooks, and reconcile billing. Built for prop
    firms integrating from their own backend.


    Authentication, quick start, error handling, idempotency, pagination, custom
    metadata, webhooks, and the MCP connector are documented at
    https://docs.hyperprop.com.
  x-logo:
    url: https://app.hyperprop.com/logo-icon.svg
    altText: Hyperprop
    href: https://hyperprop.com
servers:
  - url: https://api.hyperprop.com/platform
    description: Production
security: []
tags:
  - name: Trading accounts
    description: Create, update, and inspect trading accounts.
  - name: Traders
    description: Look up and update the traders in your organization.
  - name: Trading plans
    description: Define the plans you sell.
  - name: Trading rules
    description: Define how accounts are evaluated.
  - name: Instruments
    description: >-
      The contracts your organization's accounts can trade, with their
      specifications.
  - name: Lockouts
    description: Pause and resume trading on an account.
  - name: Payouts
    description: Check payout eligibility and record payouts.
  - name: Purchases
    description: Purchases recorded for your organization.
  - name: Time Machine
    description: Restore accounts to an earlier trading day or instant.
  - name: Mass credit
    description: >-
      Credit back losses across many accounts after an incident, as background
      jobs you can follow, pause, export and reverse.
  - name: Webhooks
    description: Register webhook endpoints and inspect deliveries.
  - name: Events
    description: Your organization's event history, to replay or audit what happened.
  - name: Real-time streams
    description: >-
      Live events and trading data over a WebSocket, for dashboards and CRMs
      that update as things happen.
  - name: Reconciliation
    description: Balances, end-of-day snapshots, and fills for reconciliation.
  - name: Analytics
    description: Organization performance, revenue and top traders.
  - name: Risk
    description: Firm profit and loss and plan economics.
  - name: Trader insights
    description: >-
      What your traders hold right now and over time, your top traders, and the
      traders you follow.
  - name: Billing and invoices
    description: >-
      Your Hyperprop invoices, credits and billing details, with usage so far
      this month, billing cycles, forecasts and CSV exports.
  - name: Team and roles
    description: Manage dashboard access for your staff.
  - name: API keys
    description: >-
      Manage your organization's API keys: rotation, read-only keys and IP
      allowlists.
  - name: Logs and health
    description: >-
      API request logs, the audit log, integration health, and idempotency key
      recovery.
  - name: Organization profile
    description: Your organization's profile and logo.
  - name: Support
    description: Open and follow up on support tickets.
  - name: Partner access
    description: >-
      Read a trader's journal as an approved partner app, with the trader's own
      key.
paths:
  /v1/organization/insights/watchlist/{traderId}:
    put:
      tags:
        - Trader insights
      summary: Follow a trader
      description: >-
        Adds one of your traders to the list your organization follows, or
        updates the note. Repeating the call is safe. You can follow at most 100
        traders.


        ## Example


        ```bash

        curl -X PUT
        "https://api.hyperprop.com/platform/v1/organization/insights/watchlist/2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b"
        \
          -H "X-API-Key: hp_live_your_key_here" \
          -H "Content-Type: application/json" \
          -d '{"note": "Consistent NQ scalper"}'
        ```


        **Permissions:** requires **manage** access to "Traders & accounts".


        **Access:** full-access API keys only (a read-only key gets `403
        READ_ONLY_KEY`). Dashboard members need manage access to Traders &
        accounts.
      operationId: putV1OrganizationInsightsWatchlistTraderid
      parameters:
        - description: '`traderId` from the positioning read or the top traders list'
          name: traderId
          in: path
          required: true
          example: 2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b
          schema:
            type: string
            maxLength: 64
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            Optional. A value that identifies this operation on your side, at
            most 255 characters. A retry with the same key, method, path and
            body within 24 hours returns the original response (with
            `Idempotency-Replayed: true`) instead of repeating the change. The
            same key with a different body returns `409 IDEMPOTENCY_KEY_REUSED`;
            a retry while the first request is still running returns `409
            IDEMPOTENCY_KEY_IN_PROGRESS`. A response that contains a credential
            (such as a new API key or signing secret) is not saved: the change
            is still not repeated, and a retry returns `409
            IDEMPOTENCY_KEY_COMPLETED` with the original status in
            `originalStatus`. Server errors (5xx) are not saved, so a retry runs
            again. If the key cannot be recorded, the request is not run and
            returns `503 IDEMPOTENCY_UNAVAILABLE`; retry with the same key.
          example: crm-sync-8814-attempt-1
          schema:
            type: string
            maxLength: 255
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model2303'
      responses:
        '200':
          description: The followed trader
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model2305'
        '400':
          description: Not a trader ID (`INVALID_TRADER_ID`), or an invalid note
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model15'
        '403':
          description: This API key does not have admin permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model511'
        '404':
          description: The trader has no account at your organization (`TRADER_NOT_FOUND`)
        '409':
          description: >-
            Already following 100 traders (`WATCHLIST_FULL`). Also
            `IDEMPOTENCY_KEY_REUSED` (the `Idempotency-Key` was used with a
            different body), `IDEMPOTENCY_KEY_IN_PROGRESS` (a request with the
            same key is still running) or `IDEMPOTENCY_KEY_COMPLETED` (the
            request with this key already completed and its response is not
            available again).
        '429':
          description: Too many changes for your organization (`RATE_LIMITED`)
        '500':
          description: Internal error (`WATCHLIST_ERROR`)
        '503':
          description: Not available yet (`WATCHLIST_UNAVAILABLE`)
      security:
        - X-API-Key: []
components:
  schemas:
    Model2303:
      type: object
      properties:
        note:
          type: string
          description: Why you follow this trader
          example: Consistent NQ scalper
          maxLength: 280
    Model2305:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model2304'
    Model15:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: Authentication required
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: UNAUTHORIZED
    Model511:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 403
        error:
          type: string
          example: Forbidden
        message:
          type: string
          example: This API key does not have admin permissions
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: INSUFFICIENT_PERMISSIONS
    Model2304:
      type: object
      properties:
        organizationId:
          type: string
        entry:
          $ref: '#/components/schemas/Model521'
    Model521:
      type: object
      properties:
        traderId:
          type: string
          example: 2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b
        traderName:
          type: string
          example: Jane Trader
        traderEmail:
          type: string
          example: jane@example.com
        note:
          type: string
          example: Consistent NQ scalper
        addedBy:
          type: string
          description: The staff member who followed the trader; null for an API key
          example: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d
        createdAt:
          type: string
          example: '2026-11-03T16:00:00.000Z'
        updatedAt:
          type: string
          example: '2026-11-03T16:00:00.000Z'
        accounts:
          $ref: '#/components/schemas/Model520'
    Model520:
      type: array
      description: The trader's accounts at your organization that can trade
      items:
        $ref: '#/components/schemas/Model519'
    Model519:
      type: object
      properties:
        accountId:
          type: string
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        accountNumber:
          type: string
          example: ACC-50K-000123
        status:
          type: string
          example: in_progress
        accountType:
          type: string
          example: sim_funded
        planName:
          type: string
          example: 50K Pro
  securitySchemes:
    X-API-Key:
      type: apiKey
      name: X-API-Key
      in: header
      description: >-
        Organization API key (`hp_live_...`), sent in the `X-API-Key` header.
        Create, rotate and restrict keys in the dashboard or with the API keys
        endpoints; an organization can have two active keys, so you can rotate
        without downtime. A **full-access** key can call every endpoint in this
        reference. A **read-only** key can call `GET` endpoints (and create a
        trading stream token); any other request returns `403 READ_ONLY_KEY`. A
        key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other
        address. Each endpoint lists which keys can call it under **Access**.

````

## Related topics

- [List the traders you follow](https://docs.hyperprop.com/platform-api/trader-insights/list-the-traders-you-follow.md)
- [List the entries and exits of the traders you follow](https://docs.hyperprop.com/platform-api/trader-insights/list-the-entries-and-exits-of-the-traders-you-follow.md)
- [Stop following a trader](https://docs.hyperprop.com/platform-api/trader-insights/stop-following-a-trader.md)
- [Get live exposure by product and trader](https://docs.hyperprop.com/platform-api/trader-insights/get-live-exposure-by-product-and-trader.md)
- [Unlink a trader (issues a fresh import key)](https://docs.hyperprop.com/platform-api/trading-accounts/unlink-a-trader-issues-a-fresh-import-key.md)


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