> ## 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.

# Get revert settings

> How a **point-in-time restore** (`revertTo` on `POST /accounts/{accountId}/revert-trading-day` and `POST /accounts/revert-trading-day`) treats the high-water mark and the trading day of the instant. End-of-day reverts (`tradingDay`) are not affected.

| Field | Values |
|---|---|
| `instantRevertHighWaterMark` | `at_instant` (default): the high-water mark as it stood at the instant. Intraday-trailing accounts take the peak balance up to the instant; end-of-day-trailing accounts the last close's value. · `restored_balance`: as `at_instant`, and the restored balance also counts as a high, as if the day had closed at the instant. Stricter: the trailing floor rises to the restored balance minus the drawdown. · `keep_current`: the revert leaves the high-water mark as it is. |
| `instantRevertDaySnapshot` | `partial` (default): the trading day containing the instant keeps its snapshot, cut at the instant: ending balance = restored balance, P&L, fills and contracts up to the instant. The day stays in calendars, reports and consistency. · `void`: the whole trading day of the instant is voided, like every later day. |

Undo restores the snapshot of the instant's day as it was before the revert.



## OpenAPI

````yaml https://api.hyperprop.com/platform/openapi.json get /v1/organization/time-machine-settings
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: 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 and real-time event stream.
  - name: Reconciliation
    description: Balances, end-of-day snapshots, and fills for reconciliation.
  - name: Analytics
    description: Organization performance and plan economics.
  - name: Billing
    description: 'Your Hyperprop bill: activity, billing cycles, and forecasts.'
  - name: Team and roles
    description: Manage dashboard access for your staff.
  - name: API keys
    description: Manage your organization's API key.
  - 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/time-machine-settings:
    get:
      tags:
        - Time Machine
      summary: Get revert settings
      description: >-
        How a **point-in-time restore** (`revertTo` on `POST
        /accounts/{accountId}/revert-trading-day` and `POST
        /accounts/revert-trading-day`) treats the high-water mark and the
        trading day of the instant. End-of-day reverts (`tradingDay`) are not
        affected.


        | Field | Values |

        |---|---|

        | `instantRevertHighWaterMark` | `at_instant` (default): the high-water
        mark as it stood at the instant. Intraday-trailing accounts take the
        peak balance up to the instant; end-of-day-trailing accounts the last
        close's value. · `restored_balance`: as `at_instant`, and the restored
        balance also counts as a high, as if the day had closed at the instant.
        Stricter: the trailing floor rises to the restored balance minus the
        drawdown. · `keep_current`: the revert leaves the high-water mark as it
        is. |

        | `instantRevertDaySnapshot` | `partial` (default): the trading day
        containing the instant keeps its snapshot, cut at the instant: ending
        balance = restored balance, P&L, fills and contracts up to the instant.
        The day stays in calendars, reports and consistency. · `void`: the whole
        trading day of the instant is voided, like every later day. |


        Undo restores the snapshot of the instant's day as it was before the
        revert.
      operationId: getV1OrganizationTimemachinesettings
      responses:
        '200':
          description: Time Machine settings
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model204'
        '504':
          description: >-
            Gateway Timeout - The request did not complete within 25 seconds
            (`REQUEST_TIMEOUT`). Nothing was changed; retry, or narrow the
            request (for example a shorter date range).
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model205'
      security:
        - X-API-Key: []
components:
  schemas:
    Model204:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model203'
    Model205:
      type: object
      properties:
        statusCode:
          type: number
          example: 504
        error:
          type: string
          example: Gateway Timeout
        message:
          type: string
          example: >-
            The request did not complete within 25 seconds. Try again, or narrow
            it (for example a shorter date range).
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: REQUEST_TIMEOUT
    Model203:
      type: object
      properties:
        instantRevertHighWaterMark:
          $ref: '#/components/schemas/instantRevertHighWaterMark'
        instantRevertDaySnapshot:
          $ref: '#/components/schemas/instantRevertDaySnapshot'
    instantRevertHighWaterMark:
      type: string
      description: >-
        High-water mark after a point-in-time (revertTo) restore: at_instant
        (default) = as it stood at the instant · restored_balance = the restored
        balance also counts as a high · keep_current = unchanged by the revert
      example: at_instant
      enum:
        - at_instant
        - restored_balance
        - keep_current
    instantRevertDaySnapshot:
      type: string
      description: >-
        The instant's trading-day snapshot after a point-in-time restore:
        partial (default) = kept with the activity up to the instant · void =
        the whole day is voided
      example: partial
      enum:
        - partial
        - void
  securitySchemes:
    X-API-Key:
      type: apiKey
      name: X-API-Key
      in: header
      description: >-
        Organization API key. Format: "hp_live_{key}". Organization admins
        manage the key in the dashboard.

````

## Related topics

- [Update revert settings](https://docs.hyperprop.com/platform-api/time-machine/update-revert-settings.md)
- [Revert an account to a trading day or an instant](https://docs.hyperprop.com/platform-api/time-machine/revert-an-account-to-a-trading-day-or-an-instant.md)
- [List revert batches](https://docs.hyperprop.com/platform-api/time-machine/list-revert-batches.md)
- [Undo a revert batch](https://docs.hyperprop.com/platform-api/time-machine/undo-a-revert-batch.md)
- [Inspect a revert batch](https://docs.hyperprop.com/platform-api/time-machine/inspect-a-revert-batch.md)


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