# Hyperprop Platform API

## Docs

- [Authentication](https://docs.hyperprop.com/authentication.md): API keys for your backend, Bearer tokens for user sessions.
- [Changelog](https://docs.hyperprop.com/changelog.md): Partner-facing changes to the Hyperprop APIs, webhooks, and docs.
- [Errors](https://docs.hyperprop.com/concepts/errors.md): One uniform envelope, machine-readable codes.
- [Idempotency](https://docs.hyperprop.com/concepts/idempotency.md): Retry any write safely — every mutating endpoint honors idempotency keys.
- [Custom Metadata](https://docs.hyperprop.com/concepts/metadata.md): Attach your own references to accounts, purchases, traders, plans, and rules.
- [Pagination & Sorting](https://docs.hyperprop.com/concepts/pagination.md): Cursor pagination (recommended) or offset, plus per-endpoint sorting.
- [Rate Limits & Quotas](https://docs.hyperprop.com/concepts/rate-limits.md): What is rate-limited, the exact numbers, and how to handle 429s.
- [MCP Connector (AI Agents)](https://docs.hyperprop.com/guides/mcp-connector.md): Let AI assistants operate your organization through the built-in MCP server.
- [Partner integrations](https://docs.hyperprop.com/guides/partner-integrations.md): Trade on behalf of a trader, at one firm, with a key the trader controls.
- [Webhooks](https://docs.hyperprop.com/guides/webhooks.md): Signed account lifecycle events with retries, redelivery, and deduplication.
- [Introduction](https://docs.hyperprop.com/introduction.md): REST API for the Hyperprop trading platform — built for prop firms integrating from their own backend.
- [GET /depth/history — rolling order-book depth history.](https://docs.hyperprop.com/market-data-api/historical/get-depthhistory-—-rolling-order-book-depth-history.md): Returns up to ~3 hours of one-second order-book snapshots (10 levels per side) for a contract. Call it once on load to paint a depth heatmap across existing chart history immediately, then keep it current with the live Depth WebSocket channel.
- [GET /historical - Fetch historical OHLC bars](https://docs.hyperprop.com/market-data-api/historical/get-historical--fetch-historical-ohlc-bars.md): Fetches historical OHLC bars from the platform's bar store.
- [GET /historical/latest - Fetch latest OHLC bars for gap fill.](https://docs.hyperprop.com/market-data-api/historical/get-historicallatest--fetch-latest-ohlc-bars-for-gap-fill.md)
- [Get current OHLC bars](https://docs.hyperprop.com/market-data-api/ohlc/get-current-ohlc-bars.md): Returns the latest OHLC bar for all tracked futures symbols. Bars update in real time from the live market data feed.
- [Get all order books (best bid/ask)](https://docs.hyperprop.com/market-data-api/order-book/get-all-order-books-best-bidask.md): Returns the current best bid and ask for all tracked futures symbols.
- [Get order book for a specific symbol](https://docs.hyperprop.com/market-data-api/order-book/get-order-book-for-a-specific-symbol.md): Returns the current best bid and ask for a specific symbol. You can use either the base symbol (ES) or full contract (ESH6).
- [Health check endpoint](https://docs.hyperprop.com/market-data-api/system/health-check-endpoint.md): Returns "OK" if the server is running and healthy. Use this for load balancer health checks and monitoring.
- [Server information](https://docs.hyperprop.com/market-data-api/system/server-information.md): Returns metadata about the running server including name, version, and status.
- [Get current ticker prices](https://docs.hyperprop.com/market-data-api/tickers/get-current-ticker-prices.md): Returns the latest price for all tracked futures symbols. Prices update in real time from the live market data feed.
- [WebSocket Stream (Documentation Only)](https://docs.hyperprop.com/market-data-api/websocket/websocket-stream-documentation-only.md): Real-time market data streaming via WebSocket with channel subscriptions.
- [Confirm password reset with tokens](https://docs.hyperprop.com/platform-api/authentication/confirm-password-reset-with-tokens.md): Resets password using the accessToken and refreshToken from the URL hash fragment. Both tokens are required. Rejections are distinguished by `code`: `SAME_PASSWORD` when the new password equals the current one, `WEAK_PASSWORD` when it fails the password policy, `INVALID_RESET_TOKEN` when the recover…
- [Connect Discord account](https://docs.hyperprop.com/platform-api/authentication/connect-discord-account.md): Returns the Discord OAuth 2.0 authorization URL (scopes: identify, guilds, guilds.members.read). Redirect the user there; on callback we verify they are a member of the Hyperprop Discord server AND hold the verification role before linking.
- [Connect X (Twitter) account](https://docs.hyperprop.com/platform-api/authentication/connect-x-twitter-account.md): Returns the X OAuth 2.0 authorization URL. Redirect the user to this URL to connect their X account.
- [Create TOTP challenge](https://docs.hyperprop.com/platform-api/authentication/create-totp-challenge.md): Creates a challenge for TOTP verification during login
- [Disable TOTP](https://docs.hyperprop.com/platform-api/authentication/disable-totp.md): Removes TOTP from the account, disabling two-factor authentication
- [Disconnect Discord account](https://docs.hyperprop.com/platform-api/authentication/disconnect-discord-account.md): Removes the Discord account link.
- [Disconnect X account](https://docs.hyperprop.com/platform-api/authentication/disconnect-x-account.md): Removes the X account connection and deletes stored tokens.
- [Discord OAuth callback](https://docs.hyperprop.com/platform-api/authentication/discord-oauth-callback.md): Handles the OAuth callback from Discord. Verifies server membership and that the user holds the verification role, then links the account and (best-effort) grants the member their seniority role. Redirects back to the app with a result: discord=linked (verified & linked), discord=not_member (not in…
- [Get current authenticated user](https://docs.hyperprop.com/platform-api/authentication/get-current-authenticated-user.md): Returns information about the currently authenticated user, including their role (user or organization). For organization users, also returns organization details and team role.
- [Get Discord connection status](https://docs.hyperprop.com/platform-api/authentication/get-discord-connection-status.md): Returns whether the user has linked their Discord account, their Discord username, and whether they are a verified member of the server.
- [Get MFA factors](https://docs.hyperprop.com/platform-api/authentication/get-mfa-factors.md): Returns list of all enrolled MFA factors
- [Get MFA status](https://docs.hyperprop.com/platform-api/authentication/get-mfa-status.md): Returns whether TOTP is enabled and list of enrolled factors
- [Get X connection status](https://docs.hyperprop.com/platform-api/authentication/get-x-connection-status.md): Returns whether the user has connected their X account and their X username.
- [Handle OAuth callback - redirects to frontend with hash fragment intact](https://docs.hyperprop.com/platform-api/authentication/handle-oauth-callback--redirects-to-frontend-with-hash-fragment-intact.md)
- [Link Google account to existing user](https://docs.hyperprop.com/platform-api/authentication/link-google-account-to-existing-user.md)
- [Post tweet with image](https://docs.hyperprop.com/platform-api/authentication/post-tweet-with-image.md): Posts a tweet with an attached image to the user's connected X account. Requires a connected X account.
- [Refresh session token](https://docs.hyperprop.com/platform-api/authentication/refresh-session-token.md): Exchange a refresh token for a new access token + refresh token pair.
- [Request password reset email](https://docs.hyperprop.com/platform-api/authentication/request-password-reset-email.md): Sends a password reset email to the specified email address if it exists
- [Resend email verification](https://docs.hyperprop.com/platform-api/authentication/resend-email-verification.md): Resends the verification email to the user.
- [Sign in with email and password](https://docs.hyperprop.com/platform-api/authentication/sign-in-with-email-and-password.md): Authenticates a user and returns a session token. If MFA is enabled, returns MFA challenge info. Use the optional "role" parameter to specify login type - "user" for regular users, "organization" for enterprise accounts.
- [Sign in with Google](https://docs.hyperprop.com/platform-api/authentication/sign-in-with-google.md): Redirects to Google for OAuth authentication
- [Sign out the current user](https://docs.hyperprop.com/platform-api/authentication/sign-out-the-current-user.md): Ends the current user session
- [Sign up a new user](https://docs.hyperprop.com/platform-api/authentication/sign-up-a-new-user.md): Creates a new user account with email and password. A user profile with a random username is automatically created.
- [Start TOTP enrollment](https://docs.hyperprop.com/platform-api/authentication/start-totp-enrollment.md): Starts TOTP enrollment and returns QR code and secret for authenticator app
- [Unlink Google account from user](https://docs.hyperprop.com/platform-api/authentication/unlink-google-account-from-user.md)
- [Update password for authenticated user](https://docs.hyperprop.com/platform-api/authentication/update-password-for-authenticated-user.md)
- [Verify an OAuth session (Google sign-in)](https://docs.hyperprop.com/platform-api/authentication/verify-an-oauth-session-google-sign-in.md): Validates the session obtained via an OAuth provider (currently Google) and runs the exact same checks as password sign-in before granting access:
- [Verify email with OTP token](https://docs.hyperprop.com/platform-api/authentication/verify-email-with-otp-token.md): Verifies user email using the OTP token sent to their email
- [Verify TOTP challenge](https://docs.hyperprop.com/platform-api/authentication/verify-totp-challenge.md): Verifies the TOTP code to complete MFA login
- [Verify TOTP enrollment](https://docs.hyperprop.com/platform-api/authentication/verify-totp-enrollment.md): Completes TOTP enrollment by verifying a code from the authenticator app
- [X OAuth callback](https://docs.hyperprop.com/platform-api/authentication/x-oauth-callback.md): Handles the OAuth callback from X. Exchanges the authorization code for tokens and stores the connection.
- [Create community post](https://docs.hyperprop.com/platform-api/community/create-community-post.md): Creates a new forum-style Community post for the authenticated user. The API stores the post and returns the hydrated post with author profile data.
- [List community posts](https://docs.hyperprop.com/platform-api/community/list-community-posts.md): Public endpoint for the Hyperprop Community forum. Returns newest posts first with lightweight author profile data for display.
- [Upload community image](https://docs.hyperprop.com/platform-api/community/upload-community-image.md): Uploads one image to the `communityBucket` storage bucket for later attachment to a Community post. Send multipart/form-data with the file in a field named `image`. Allowed formats: JPEG, PNG, GIF, WebP. Max size: 5MB. The returned `imageUrl` can be passed in `imageUrls` when creating a post.
- [Delete any account](https://docs.hyperprop.com/platform-api/demo/delete-any-account.md): Permanently deletes any trading account owned by the authenticated user, regardless of whether it is a demo account or not. Also removes the associated purchase record and audit trail entries. Use with caution.
- [Delete demo account](https://docs.hyperprop.com/platform-api/demo/delete-demo-account.md): Deletes a demo trading account and its associated purchase. Only works for accounts that have `is_demo: true` in metadata and belong to the authenticated user.
- [Import demo account](https://docs.hyperprop.com/platform-api/demo/import-demo-account.md): Creates a demo trading account for the authenticated user. The account is free for the trader and starts in `in_progress` status. Internally the purchase records the plan list price so organization revenue analytics stay realistic; that price is never returned to the trader. Demo accounts are marked…
- [List demo accounts](https://docs.hyperprop.com/platform-api/demo/list-demo-accounts.md): Returns all demo trading accounts for the authenticated user, with organization and plan details.
- [List demo organization plans](https://docs.hyperprop.com/platform-api/demo/list-demo-organization-plans.md): Returns available trading plans for a demo organization, including their rules (profit target, max loss, consistency template, etc.). Plans with `accountType: sim_funded` import as sim-funded accounts where consistency gates payouts instead of passing.
- [List demo organizations](https://docs.hyperprop.com/platform-api/demo/list-demo-organizations.md): Returns organizations that have demo accounts enabled. Users can import demo trading accounts from these organizations.
- [Get available products](https://docs.hyperprop.com/platform-api/market-data/get-available-products.md): ## Overview
- [Get CME contracts](https://docs.hyperprop.com/platform-api/market-data/get-cme-contracts.md): ## Overview
- [Get contract by ID](https://docs.hyperprop.com/platform-api/market-data/get-contract-by-id.md): ## Overview
- [Add a team member with a role](https://docs.hyperprop.com/platform-api/organization/add-a-team-member-with-a-role.md): Create a login for a new staff member (or link an existing account) and assign them a role.
- [Bulk-create unlinked accounts with import keys](https://docs.hyperprop.com/platform-api/organization/bulk-create-unlinked-accounts-with-import-keys.md): Create up to **100 unlinked accounts** in one call — for giveaways, competitions, or pre-provisioning inventory.
- [Bulk update trading accounts](https://docs.hyperprop.com/platform-api/organization/bulk-update-trading-accounts.md): Bulk update multiple trading accounts at once. **Admin only**.
- [Change a team member's role](https://docs.hyperprop.com/platform-api/organization/change-a-team-members-role.md): Assign a different role to an existing team member. Takes effect on their next request — no re-login needed.
- [Check payout eligibility](https://docs.hyperprop.com/platform-api/organization/check-payout-eligibility.md): Pre-check whether a payout would succeed right now, without executing anything.
- [Create a custom role](https://docs.hyperprop.com/platform-api/organization/create-a-custom-role.md): Create a role with exactly the access your team needs. Any domain you omit defaults to `none` (hidden).
- [Create a new trading plan](https://docs.hyperprop.com/platform-api/organization/create-a-new-trading-plan.md): Create a new trading plan for your organization. **Admin only**.
- [Create a new trading rule](https://docs.hyperprop.com/platform-api/organization/create-a-new-trading-rule.md): Create a new trading rule for your organization. **Admin only**.
- [Create a trading account](https://docs.hyperprop.com/platform-api/organization/create-a-trading-account.md): Create a new trading account for a trader. This is the main endpoint for provisioning accounts after a purchase.
- [Create admin lockout](https://docs.hyperprop.com/platform-api/organization/create-admin-lockout.md): Lock a trading account so the trader cannot open new risk. Risk-reducing actions (closing positions, cancelling orders, flattening) always remain available to the trader — a lockout can never trap someone in a losing position.
- [Create an API key](https://docs.hyperprop.com/platform-api/organization/create-an-api-key.md): Create a new API key for your organization. **Admin only.**
- [Delete a trading plan](https://docs.hyperprop.com/platform-api/organization/delete-a-trading-plan.md): Delete a trading plan. **Admin only**.
- [Delete a trading rule](https://docs.hyperprop.com/platform-api/organization/delete-a-trading-rule.md): Delete a trading rule. **Admin only**.
- [Delete a webhook](https://docs.hyperprop.com/platform-api/organization/delete-a-webhook.md): Permanently deletes a webhook and all its delivery history.
- [Delete an API key](https://docs.hyperprop.com/platform-api/organization/delete-an-api-key.md): Permanently delete an API key. **Admin only.**
- [Delete an unused custom role](https://docs.hyperprop.com/platform-api/organization/delete-an-unused-custom-role.md): Delete a custom role. The role must not be assigned to any team member — reassign them first. System presets cannot be deleted.
- [Delete organization logo](https://docs.hyperprop.com/platform-api/organization/delete-organization-logo.md): Remove your organization's logo.
- [Execute a payout (balance withdrawal)](https://docs.hyperprop.com/platform-api/organization/execute-a-payout-balance-withdrawal.md): Withdraw balance from a trading account **synchronously** — the trade engine deducts the amount in-memory within milliseconds and persists in the background.
- [Generate a new temporary password for a team member](https://docs.hyperprop.com/platform-api/organization/generate-a-new-temporary-password-for-a-team-member.md): Use this when a staff member is locked out or forgot their password. A new strong temporary password is generated and returned **once** — copy it and share it securely. The member should change it after signing in (Settings → Security).
- [Get a specific purchase](https://docs.hyperprop.com/platform-api/organization/get-a-specific-purchase.md): Retrieve complete details for a single purchase by its ID.
- [Get a specific trader](https://docs.hyperprop.com/platform-api/organization/get-a-specific-trader.md): Get detailed information about a specific trader in your organization.
- [Get a specific trading account](https://docs.hyperprop.com/platform-api/organization/get-a-specific-trading-account.md): Retrieve complete details for a single trading account by its ID.
- [Get a specific trading plan](https://docs.hyperprop.com/platform-api/organization/get-a-specific-trading-plan.md): Retrieve complete details for a single trading plan by its ID.
- [Get a specific trading rule](https://docs.hyperprop.com/platform-api/organization/get-a-specific-trading-rule.md): Retrieve complete details for a single trading rule by its ID.
- [Get account change history](https://docs.hyperprop.com/platform-api/organization/get-account-change-history.md): Get the audit trail of all changes made to a trading account.
- [Get all-months billing aggregates](https://docs.hyperprop.com/platform-api/organization/get-all-months-billing-aggregates.md): One row per calendar month across your organization's entire billing history — cycle counts (split into first cycles vs renewals), distinct billable traders, and amounts split into platform fee vs CME market data. Months follow CME's clock (America/Chicago).
- [Get bulk operation details](https://docs.hyperprop.com/platform-api/organization/get-bulk-operation-details.md): Get details of a bulk update operation by its batch ID.
- [Get daily account creation activity](https://docs.hyperprop.com/platform-api/organization/get-daily-account-creation-activity.md): Returns the daily count of trading accounts provisioned for your organization. Use this for an account-growth chart without downloading or aggregating every page of the trading-accounts list client-side.
- [Get daily billing activity](https://docs.hyperprop.com/platform-api/organization/get-daily-billing-activity.md): Returns billing cycle charges grouped by UTC day for a compact activity chart. Each point includes the total amount, its split into `platformAmount` (the Hyperprop platform fee) and `marketDataAmount` (the CME Group market data bundle), and the number of cycle line items started on that day — so `pl…
- [Get daily lockout activity](https://docs.hyperprop.com/platform-api/organization/get-daily-lockout-activity.md): Returns organization lockouts grouped by UTC day: how many were applied and how many were removed. The aggregate runs server-side and returns only active days, keeping the response bounded for high-volume organizations.
- [Get daily payout activity](https://docs.hyperprop.com/platform-api/organization/get-daily-payout-activity.md): Returns organization-wide payout volume grouped by UTC day. Each point includes both the total amount paid and number of payouts, so dashboards can switch between dollar volume and transaction count without loading every account's individual payout ledger.
- [Get daily webhook delivery activity](https://docs.hyperprop.com/platform-api/organization/get-daily-webhook-delivery-activity.md): Returns organization-wide webhook delivery counts grouped by UTC day.
- [Get end-of-day account snapshots](https://docs.hyperprop.com/platform-api/organization/get-end-of-day-account-snapshots.md): Returns every account that traded during a CME trading day, with their end-of-day balances and performance.
- [Get events for a billing cycle](https://docs.hyperprop.com/platform-api/organization/get-events-for-a-billing-cycle.md): Returns a paginated audit trail for a billing cycle owned by the authenticated organization — creation, renewal, expiry, and entitlement changes. Cross-organization cycle IDs return 404.
- [Get fills for a trading day](https://docs.hyperprop.com/platform-api/organization/get-fills-for-a-trading-day.md): Returns every fill (trade execution) for your organization's accounts during a CME trading day.
- [Get integration health (alerts, errors, insights)](https://docs.hyperprop.com/platform-api/organization/get-integration-health-alerts-errors-insights.md): Computed health overview of your integration, Stripe-Workbench style:
- [Get lockout status for account](https://docs.hyperprop.com/platform-api/organization/get-lockout-status-for-account.md): Returns the current active lockout (if any) for a trading account.
- [Get monthly billing summary](https://docs.hyperprop.com/platform-api/organization/get-monthly-billing-summary.md): Returns the billing summary for a specific month — total amount owed, number of billable users, one bounded page of charge line items, and your organization's current rate card.
- [Get monthly firm P&L (revenue vs payouts vs platform costs)](https://docs.hyperprop.com/platform-api/organization/get-monthly-firm-p&l-revenue-vs-payouts-vs-platform-costs.md): Monthly profitability of your firm on Hyperprop: evaluation revenue in, trader payouts and your Hyperprop platform/CME bill out.
- [Get organization analytics](https://docs.hyperprop.com/platform-api/organization/get-organization-analytics.md): Retrieve aggregate analytics and statistics for your organization's trading accounts in a single call.
- [Get organization audit log](https://docs.hyperprop.com/platform-api/organization/get-organization-audit-log.md): Get the complete audit log of all trading account changes for your organization.
- [Get per-plan unit economics and sustainability flags](https://docs.hyperprop.com/platform-api/organization/get-per-plan-unit-economics-and-sustainability-flags.md): Which of your trading plans make money and which are risks. One row per plan with sales, outcomes, attributable payouts, and a sustainability flag.
- [Get purchases for your organization](https://docs.hyperprop.com/platform-api/organization/get-purchases-for-your-organization.md): Retrieve all purchase records for your organization with powerful filtering options.
- [Get team members for your organization](https://docs.hyperprop.com/platform-api/organization/get-team-members-for-your-organization.md): View all staff members who have access to your organization's dashboard.
- [Get traders for your organization](https://docs.hyperprop.com/platform-api/organization/get-traders-for-your-organization.md): Returns all traders who have accounts with your organization.
- [Get trading accounts for your organization](https://docs.hyperprop.com/platform-api/organization/get-trading-accounts-for-your-organization.md): Retrieve all trading accounts for your organization with powerful filtering and search.
- [Get trading plans for your organization](https://docs.hyperprop.com/platform-api/organization/get-trading-plans-for-your-organization.md): Retrieve all trading plans configured for your organization.
- [Get trading rules for your organization](https://docs.hyperprop.com/platform-api/organization/get-trading-rules-for-your-organization.md): Retrieve all trading rules configured for your organization.
- [Get webhook details](https://docs.hyperprop.com/platform-api/organization/get-webhook-details.md): Retrieve a single webhook's configuration and status. The signing secret is **not** included.
- [Get webhook endpoint delivery and latency metrics](https://docs.hyperprop.com/platform-api/organization/get-webhook-endpoint-delivery-and-latency-metrics.md): Returns daily performance telemetry for one webhook endpoint:
- [Get your organization profile](https://docs.hyperprop.com/platform-api/organization/get-your-organization-profile.md): Retrieve your organization's public profile information.
- [Inspect a webhook event and all delivery attempts](https://docs.hyperprop.com/platform-api/organization/inspect-a-webhook-event-and-all-delivery-attempts.md): Stripe-style detail for one webhook delivery.
- [Inspect one event and all its webhook deliveries](https://docs.hyperprop.com/platform-api/organization/inspect-one-event-and-all-its-webhook-deliveries.md): Full Stripe-style inspection of a single event:
- [List all active lockouts](https://docs.hyperprop.com/platform-api/organization/list-all-active-lockouts.md): Returns all active lockouts across your organization.
- [List all billing events](https://docs.hyperprop.com/platform-api/organization/list-all-billing-events.md): Returns the complete billing event audit trail for your organization.
- [List all organization events](https://docs.hyperprop.com/platform-api/organization/list-all-organization-events.md): Stripe-style event feed: **every** event that happened in your organization, newest first — including events no webhook was subscribed to (those simply have an empty `deliveries` array) and manual `webhook.test` events.
- [List all webhooks](https://docs.hyperprop.com/platform-api/organization/list-all-webhooks.md): Returns all registered webhooks for your organization.
- [List API keys](https://docs.hyperprop.com/platform-api/organization/list-api-keys.md): List your organization's API keys. **Admin only.**
- [List API request logs](https://docs.hyperprop.com/platform-api/organization/list-api-request-logs.md): Stripe-style request log of every authenticated call your organization made to the Platform API (both `X-API-Key` and dashboard-session requests), newest first.
- [List billing cycles](https://docs.hyperprop.com/platform-api/organization/list-billing-cycles.md): View all billing charges for your organization.
- [List payouts for an account](https://docs.hyperprop.com/platform-api/organization/list-payouts-for-an-account.md): Paginated payout ledger for one account, newest first. Every row is a completed balance withdrawal executed through the payouts endpoint.
- [List roles (system presets + your custom roles)](https://docs.hyperprop.com/platform-api/organization/list-roles-system-presets-+-your-custom-roles.md): Roles define what each team member can see and do in the dashboard and API. A role is a permission map of **domain → level**:
- [List trader identity bindings (customer ⇄ Hyperprop login)](https://docs.hyperprop.com/platform-api/organization/list-trader-identity-bindings-customer-⇄-hyperprop-login.md): One firm customer, one Hyperprop login. A **binding** pins the `customerId` you set on your accounts to a single Hyperprop login.
- [Payout queue — bulk payout eligibility](https://docs.hyperprop.com/platform-api/organization/payout-queue-—-bulk-payout-eligibility.md): List all **in-progress** accounts of a type (default `sim_funded`) with **live payout eligibility** computed for each — one call instead of checking accounts one by one. Built for payout runs: pull the queue, review who is ready, then execute payouts per account.
- [Project next month's bill from the current state](https://docs.hyperprop.com/platform-api/organization/project-next-months-bill-from-the-current-state.md): Projects the NEXT calendar month's bill from today's account state and your current rate card. Under the calendar-month model this is simple — every trader lands in exactly one bucket:
- [Real-time event stream (WebSocket)](https://docs.hyperprop.com/platform-api/organization/real-time-event-stream-websocket.md): Live push of the **same events and payloads** your webhooks receive, over a plain WebSocket. Use it for dashboards, monitoring, or low-latency reactions without hosting a public HTTPS endpoint.
- [Rebind a customer to a new Hyperprop login (support flow)](https://docs.hyperprop.com/platform-api/organization/rebind-a-customer-to-a-new-hyperprop-login-support-flow.md): Move a soulbound customer to a **new** Hyperprop login in one atomic operation. There is no plain "release" — every customer always has exactly one bound login, so a lost login is fixed by rebinding, never by leaving the customer unbound.
- [Reconcile a trading day in one call](https://docs.hyperprop.com/platform-api/organization/reconcile-a-trading-day-in-one-call.md): One call, everything you need to reconcile a trading day — collapses the separate `/snapshots/accounts` + `/snapshots/fills` requests you previously had to stitch together.
- [Redeliver a webhook delivery](https://docs.hyperprop.com/platform-api/organization/redeliver-a-webhook-delivery.md): Immediately replays a specific webhook delivery using the original payload.
- [Register a webhook endpoint](https://docs.hyperprop.com/platform-api/organization/register-a-webhook-endpoint.md): Register a URL to receive real-time event notifications via HTTP POST.
- [Remove a team member](https://docs.hyperprop.com/platform-api/organization/remove-a-team-member.md): Remove a staff member from your organization. Their login is revoked immediately (staff accounts are dedicated to your organization, so the account itself is deleted).
- [Remove lockout from account](https://docs.hyperprop.com/platform-api/organization/remove-lockout-from-account.md): Remove (cancel) the active lockout on a trading account. Admin can remove any lockout regardless of who created it.
- [Rotate signing secret](https://docs.hyperprop.com/platform-api/organization/rotate-signing-secret.md): Generates a new HMAC-SHA256 signing secret for this webhook. The old secret is invalidated **immediately** — update your verification code before rotating.
- [Send a test event](https://docs.hyperprop.com/platform-api/organization/send-a-test-event.md): Sends a `webhook.test` event to the webhook URL synchronously and returns the delivery result. Use this to verify your endpoint is reachable and correctly verifying signatures before going live.
- [Simulate any event type (QA fixture)](https://docs.hyperprop.com/platform-api/organization/simulate-any-event-type-qa-fixture.md): Delivers a synthetic event of **any real event type** (`account.passed`, `account.failed`, `fill.created`, …) to this webhook endpoint synchronously, so you can test your full pass/breach/fill handling path deterministically — no waiting for real trading activity.
- [Time Machine — bulk revert accounts to a trading day](https://docs.hyperprop.com/platform-api/organization/time-machine-—-bulk-revert-accounts-to-a-trading-day.md): **Time Machine, org-wide:** the same operation as the single-account revert, applied to many accounts in one call — built for exchange/platform outages.
- [Time Machine — inspect a revert batch](https://docs.hyperprop.com/platform-api/organization/time-machine-—-inspect-a-revert-batch.md): Everything one revert batch did, account by account: the balance and status each account had before and after, how many snapshots and orders were voided, whether positions were force-closed, and whether that account has since been undone.
- [Time Machine — list revert batches](https://docs.hyperprop.com/platform-api/organization/time-machine-—-list-revert-batches.md): The **Time Machine ledger**: every trading-day revert your organization has ever run, newest first. Single-account reverts appear as batches of one; bulk reverts as one batch covering all their accounts.
- [Time Machine — revert an account to a trading day](https://docs.hyperprop.com/platform-api/organization/time-machine-—-revert-an-account-to-a-trading-day.md): **Time Machine** (outage recovery): restore an account to its **end-of-day state** on the given trading day, in one call — the reverted period stops existing for the trader.
- [Time Machine — undo a revert batch](https://docs.hyperprop.com/platform-api/organization/time-machine-—-undo-a-revert-batch.md): **The undo button.** Puts every account in a revert batch back **exactly where it was the moment before the revert ran**: pre-revert balance, status, high-water mark and daily baseline are restored from the ledger, and every snapshot and order the batch voided is un-voided — the trader's journal, or…
- [Unlink a trader (issues a fresh import key)](https://docs.hyperprop.com/platform-api/organization/unlink-a-trader-issues-a-fresh-import-key.md): Detach the trader from an account **before trading starts** — wrong customer, refund, resale, or a mistaken import.
- [Update a custom role](https://docs.hyperprop.com/platform-api/organization/update-a-custom-role.md): Edit a custom role's name, description, or permissions. Changes apply to all members with this role on their next request.
- [Update a trader](https://docs.hyperprop.com/platform-api/organization/update-a-trader.md): Update an organization trader's metadata or external reference. Only organization **admins** can update traders.
- [Update a trading account](https://docs.hyperprop.com/platform-api/organization/update-a-trading-account.md): Update an existing trading account. This is the endpoint for reflecting anything that happens on *your* side — payouts, manual passes, balance corrections, risk decisions — onto the account. Only organization **admins** (or API keys with `write`/`admin` permission) can update accounts.
- [Update a trading plan](https://docs.hyperprop.com/platform-api/organization/update-a-trading-plan.md): Update an existing trading plan. **Admin only**.
- [Update a trading rule](https://docs.hyperprop.com/platform-api/organization/update-a-trading-rule.md): Update an existing trading rule. **Admin only**.
- [Update a webhook](https://docs.hyperprop.com/platform-api/organization/update-a-webhook.md): Partial update — include only the fields you want to change.
- [Update active lockout](https://docs.hyperprop.com/platform-api/organization/update-active-lockout.md): Update the reason or end time of an active lockout without removing and recreating it.
- [Update your organization profile](https://docs.hyperprop.com/platform-api/organization/update-your-organization-profile.md): Update your organization's public profile information.
- [Upload organization logo](https://docs.hyperprop.com/platform-api/organization/upload-organization-logo.md): Upload a new logo for your organization.
- [View webhook delivery history](https://docs.hyperprop.com/platform-api/organization/view-webhook-delivery-history.md): Paginated log of all webhook delivery attempts across your organization.
- [Create a verifiable PnL card from a closed trade](https://docs.hyperprop.com/platform-api/pnl-cards/create-a-verifiable-pnl-card-from-a-closed-trade.md): ## Overview
- [Get one of the authenticated user’s PnL cards](https://docs.hyperprop.com/platform-api/pnl-cards/get-one-of-the-authenticated-user’s-pnl-cards.md)
- [List a public profile's PnL cards](https://docs.hyperprop.com/platform-api/pnl-cards/list-a-public-profiles-pnl-cards.md): Returns the public PnL cards for a user whose profile is public. Only `visibility=public` non-revoked cards are returned. 404 if the profile is private or does not exist.
- [List the authenticated user's PnL cards](https://docs.hyperprop.com/platform-api/pnl-cards/list-the-authenticated-users-pnl-cards.md)
- [Public verification payload for a PnL card](https://docs.hyperprop.com/platform-api/pnl-cards/public-verification-payload-for-a-pnl-card.md): Returns the canonical card snapshot for any non-revoked public/unlisted card. Used by the QR-code verification page. The numbers were recomputed and stored by the server at create time, so the row itself is the attestation.
- [Revoke (soft delete) a PnL card](https://docs.hyperprop.com/platform-api/pnl-cards/revoke-soft-delete-a-pnl-card.md): Revoking sets `revoked_at` on the card. The public verify endpoint then returns 404, and the card disappears from the user’s public profile. The dedup slot is freed so the user can re-save the same trade.
- [Update a PnL card (visibility and/or description)](https://docs.hyperprop.com/platform-api/pnl-cards/update-a-pnl-card-visibility-andor-description.md)
- [Health check endpoint](https://docs.hyperprop.com/platform-api/system/health-check-endpoint.md): Simple endpoint to check if the API is running and responsive
- [Accept an agreement](https://docs.hyperprop.com/platform-api/user/accept-an-agreement.md): Records user acceptance of an agreement. Organization admins can only accept "organization" category agreements. Organization view-only users cannot accept any agreements. Regular users can accept all categories except "organization". Stores IP address and user agent for audit.
- [Check if key is dismissed](https://docs.hyperprop.com/platform-api/user/check-if-key-is-dismissed.md): Check if a specific key has been dismissed by the user
- [Create a price alert](https://docs.hyperprop.com/platform-api/user/create-a-price-alert.md): Arms an alert on one contract at one price. The trade engine watches the last TRADE price — never the order-book mid — and fires once, then sets the alert to `triggered` and emails the trader.
- [Create user profile](https://docs.hyperprop.com/platform-api/user/create-user-profile.md): Creates a profile for the authenticated user. Username must be unique. Nationality should be ISO 3166-1 alpha-2 code (e.g., US, GB, NL). Profile is private by default.
- [Delete a price alert](https://docs.hyperprop.com/platform-api/user/delete-a-price-alert.md): Removes the alert outright. Only the alert owner can delete it.
- [Delete all your price alerts](https://docs.hyperprop.com/platform-api/user/delete-all-your-price-alerts.md): Clears every alert for the trader, or only those on one contract when `contract` is given — the bulk "clear alerts on this chart" action.
- [Delete one UI preference](https://docs.hyperprop.com/platform-api/user/delete-one-ui-preference.md): Removes the preference blob stored under `key` for the authenticated user, e.g. when the trader clears all drawings for a contract. Deleting a missing key succeeds.
- [Delete user avatar](https://docs.hyperprop.com/platform-api/user/delete-user-avatar.md): Removes the avatar image from storage and sets the profile avatar to null.
- [Delete user profile](https://docs.hyperprop.com/platform-api/user/delete-user-profile.md): Deletes the authenticated user's profile permanently
- [Dismiss a key](https://docs.hyperprop.com/platform-api/user/dismiss-a-key.md): Mark a key as dismissed. Used for modals, tutorials, etc. Idempotent - calling twice returns success.
- [Get active status notices](https://docs.hyperprop.com/platform-api/user/get-active-status-notices.md): Status notices shown as a banner above the app navigation and listed in full on the public status page. **No authentication required.**
- [Get activity stream](https://docs.hyperprop.com/platform-api/user/get-activity-stream.md): Private, owner-only stream of generated PnL cards and milestones, newest first. Each item carries a `published` flag indicating whether it is on the public Social Feed.
- [Get all agreements](https://docs.hyperprop.com/platform-api/user/get-all-agreements.md): Returns active agreements based on user type. Organization admins see only "organization" category. Organization view-only users cannot access agreements. Regular users see all categories except "organization".
- [Get all dismissals](https://docs.hyperprop.com/platform-api/user/get-all-dismissals.md): Returns all dismissed keys for the authenticated user (modals, tutorials, etc.)
- [Get all UI preferences](https://docs.hyperprop.com/platform-api/user/get-all-ui-preferences.md): Returns every UI preference blob stored for the authenticated user as a map keyed by preference key. Used by the web terminal and mobile app to hydrate chart settings, active indicators, per-contract drawings, order-form defaults, sounds and similar preferences in a single call at login. Keys are na…
- [Get audit logs](https://docs.hyperprop.com/platform-api/user/get-audit-logs.md): Returns a paginated list of audit logs for the authenticated user. Logs are sorted by most recent first.
- [Get completed round-trip trades (server-derived)](https://docs.hyperprop.com/platform-api/user/get-completed-round-trip-trades-server-derived.md): The user's completed round-trip trades — one row per position episode (open-from-flat to back-to-flat), newest exit first. Scale-ins and scale-outs are merged into the episode's single trade.
- [Get economic calendar events](https://docs.hyperprop.com/platform-api/user/get-economic-calendar-events.md): Economic calendar events (CPI, NFP, central-bank decisions, …) within a date range, served from Hyperprop's own mirror — synced daily from a market-data provider, so availability does not depend on a third party at request time.
- [Get notification preferences](https://docs.hyperprop.com/platform-api/user/get-notification-preferences.md): Returns the authenticated user's notification preferences. Creates default preferences if none exist.
- [Get order history (keyset-paginated)](https://docs.hyperprop.com/platform-api/user/get-order-history-keyset-paginated.md): The user's persisted order history across all their accounts, newest first.
- [Get own social feed](https://docs.hyperprop.com/platform-api/user/get-own-social-feed.md): Returns the authenticated user's published Social Feed items (hydrated).
- [Get own user profile](https://docs.hyperprop.com/platform-api/user/get-own-user-profile.md): Returns the authenticated user's profile. For organization users, profile fields are managed by the organization and are read-only (except avatar which can be updated).
- [Get public social feed by username](https://docs.hyperprop.com/platform-api/user/get-public-social-feed-by-username.md): Public, visitor-facing Social Feed for a profile. Returns 404 if the profile is private or does not exist.
- [Get user profile by account registration number](https://docs.hyperprop.com/platform-api/user/get-user-profile-by-account-registration-number.md): Public endpoint to view any user's profile by their numeric account registration number (the sequential signup number). Kept separate from the by-username endpoint so the username and registration-number namespaces never collide (all-digit usernames stay valid). Returns the same shape as the by-user…
- [Get user profile by username](https://docs.hyperprop.com/platform-api/user/get-user-profile-by-username.md): Public endpoint to view any user's profile by their username. To look a profile up by account registration number instead, use GET /platform/v1/user/profile/regnumber/{registrationNumber}. Both endpoints return the same shape, including both `username` and `registrationNumber`. Only public profiles…
- [Import a trading account with an import key](https://docs.hyperprop.com/platform-api/user/import-a-trading-account-with-an-import-key.md): Redeem a one-time import key (serial-key style, `HP-XXXXX-XXXXX-XXXXX`) to link a prop-firm trading account to the logged-in user.
- [List your notifications](https://docs.hyperprop.com/platform-api/user/list-your-notifications.md): The signed-in trader's notification feed, newest first, with the unread count. Page older history by passing `before` = the `createdAt` of the last row you have.
- [List your price alerts](https://docs.hyperprop.com/platform-api/user/list-your-price-alerts.md): Every alert for the signed-in trader, newest first, including ones that have already triggered. Pass `contract` to narrow it to one chart. Capped at 500 rows.
- [Mark notifications read](https://docs.hyperprop.com/platform-api/user/mark-notifications-read.md): Marks the given notifications read, or every unread one when `ids` is omitted — that is what opening the bell dropdown does.
- [Move or re-arm a price alert](https://docs.hyperprop.com/platform-api/user/move-or-re-arm-a-price-alert.md): Used when the trader drags the alert line to a new level. Send `rearm: true` to put an already-triggered alert back to `armed`, which also clears its trigger record. Only the alert owner can change it.
- [Notify market-data access granted](https://docs.hyperprop.com/platform-api/user/notify-market-data-access-granted.md): Called by the client when the market-data websocket reports access was just granted. Re-validates all onboarding conditions server-side (CME agreement, KYC, Discord link, active entitlements) and sends the "market data unlocked" email exactly once. Idempotent.
- [Preview an import key (no redemption)](https://docs.hyperprop.com/platform-api/user/preview-an-import-key-no-redemption.md): Look up what an import key unlocks — account number, plan, firm — WITHOUT redeeming it. Powers both trader-facing import surfaces: the auto-connect confirmation screen (`/connect?key=...`) and the manual Import Key dialog (Trading Accounts → Import), so the trader verifies they are importing the rig…
- [Publish to social feed](https://docs.hyperprop.com/platform-api/user/publish-to-social-feed.md): Publishes an activity item to the public Social Feed. Publishing a PnL card forces its visibility to public. Idempotent per (user, source).
- [Remove from social feed](https://docs.hyperprop.com/platform-api/user/remove-from-social-feed.md): Removes a post from the Social Feed. Does not change the underlying PnL card.
- [Save one UI preference](https://docs.hyperprop.com/platform-api/user/save-one-ui-preference.md): Creates or replaces the UI preference blob stored under `key` for the authenticated user. Last write wins — clients send debounced writes after local (optimistic) updates, so the server copy trails the device by a second or two. Maximum payload is 512KB per key; keys must match `^[a-z0-9_]+(:[A-Za-z…
- [Update notification preferences](https://docs.hyperprop.com/platform-api/user/update-notification-preferences.md): Updates the authenticated user's notification preferences. All fields are optional.
- [Update user profile](https://docs.hyperprop.com/platform-api/user/update-user-profile.md): Updates the authenticated user's profile. All fields are optional. Nationality should be ISO 3166-1 alpha-2 code (e.g., US, GB, NL). Username can only be changed once every 30 days. If the user has no profile yet, one is auto-created with a private placeholder username (user + id prefix) and the upd…
- [Upload user avatar](https://docs.hyperprop.com/platform-api/user/upload-user-avatar.md): Uploads a new avatar image. If an avatar already exists, it will be replaced. Max size: 5MB. Allowed types: JPEG, PNG, GIF, WebP.
- [Quickstart](https://docs.hyperprop.com/quickstart.md): Provision your first trading account in three requests.
- [Create a firm-scoped partner session](https://docs.hyperprop.com/trade-api/account/create-a-firm-scoped-partner-session.md): Exchanges partner app credentials + a trader API key + a firm for a short-lived bearer token. The token only acknowledges the trader's accounts at that firm: accounts the same trader holds at other firms are invisible to the session, for reads, writes and WebSocket events alike.
- [Create or update account lockout](https://docs.hyperprop.com/trade-api/account/create-or-update-account-lockout.md): Activates a lockout on the specified account. Any existing lockout for the account is replaced.
- [Generate a trader API key for third-party access](https://docs.hyperprop.com/trade-api/account/generate-a-trader-api-key-for-third-party-access.md): Creates a new API key for the authenticated trader, for use with partner integrations (e.g. Tradesyncer) via `POST /trade/partner/session`. The key stays retrievable via `GET /trade/partner/keys`, so the trader can come back and copy it again. Requires a normal Hyperprop session — partner sessions c…
- [Get account lockout status](https://docs.hyperprop.com/trade-api/account/get-account-lockout-status.md): Returns whether the specified account is currently locked out from trading, and if so, which mode is active (`timed`, `session`, `trade_clock`, `hours`, `trading_day`), when it started, when it ends, and how many minutes remain.
- [Get all trading accounts for the authenticated user](https://docs.hyperprop.com/trade-api/account/get-all-trading-accounts-for-the-authenticated-user.md): Returns every trading account the user owns, each with full details: organization info, plan info, rule info, balances, P&L, and lockout status.
- [Get current trading account with equity and P&L](https://docs.hyperprop.com/trade-api/account/get-current-trading-account-with-equity-and-p&l.md): Returns the primary trading account for the authenticated user.
- [List the trader's API keys](https://docs.hyperprop.com/trade-api/account/list-the-traders-api-keys.md): Returns all of the trader's keys, newest first — including the full key (`api_key`) so it can be copied again from the website, plus prefix, label, status, and created/last-used/revoked timestamps.
- [Remove account lockout](https://docs.hyperprop.com/trade-api/account/remove-account-lockout.md): Clears the active lockout configuration for the specified account. After removal, the account can trade again immediately.
- [Revoke one of the trader's API keys](https://docs.hyperprop.com/trade-api/account/revoke-one-of-the-traders-api-keys.md): Marks the key as revoked. New partner logins with it fail immediately; sessions already minted from it expire within the token TTL (15 minutes by default). Revocation is permanent — generate a new key to reconnect.
- [Set or clear a trading account's display nickname.](https://docs.hyperprop.com/trade-api/account/set-or-clear-a-trading-accounts-display-nickname.md): Purely cosmetic: the nickname only changes how the account is shown in Hyperprop UIs (account switcher, journal, positions). The real `account_number` is unchanged and remains the identifier used by the firm, support, exports and every API. Whitespace is trimmed; an empty or null nickname clears it.
- [Consistency status for one of the caller's accounts](https://docs.hyperprop.com/trade-api/accounts/consistency-status-for-one-of-the-callers-accounts.md): Full consistency picture for the account: the daily cap, best day, profitable-day counts, and plain-language reasons whenever the rule is currently blocking an evaluation pass (or a funded payout). Returns `consistency: null` when the account's rule has no consistency percentage configured.
- [Bulk update copy trading group followers](https://docs.hyperprop.com/trade-api/copy-trading/bulk-update-copy-trading-group-followers.md): Creates or updates an entire copy trading group in one request. Specify the leader account, group name, symbol, and an array of follower configurations (account + ratio).
- [Create or update a copy trading config](https://docs.hyperprop.com/trade-api/copy-trading/create-or-update-a-copy-trading-config.md): Creates or updates a single copy trading rule: link a follower account to a leader account for a specific symbol with a quantity ratio.
- [Delete a copy trading config](https://docs.hyperprop.com/trade-api/copy-trading/delete-a-copy-trading-config.md): Removes a specific copy trading rule identified by follower account, symbol, and group.
- [Delete all copy trading configs](https://docs.hyperprop.com/trade-api/copy-trading/delete-all-copy-trading-configs.md): Removes all copy trading configurations for the authenticated user.
- [Get copy trading configuration](https://docs.hyperprop.com/trade-api/copy-trading/get-copy-trading-configuration.md): Returns the full copy trading setup for the authenticated user: all leader-follower mappings, active/inactive state, group names, symbols, and ratios.
- [Get copy trading status and positions](https://docs.hyperprop.com/trade-api/copy-trading/get-copy-trading-status-and-positions.md): Returns the live copy trading status: which configs are active, whether the system is locked, and current positions on leader and follower accounts.
- [Toggle copy config active state](https://docs.hyperprop.com/trade-api/copy-trading/toggle-copy-config-active-state.md): Enables or disables a specific copy trading configuration without deleting it.
- [Attach TP/SL bracket to an existing order](https://docs.hyperprop.com/trade-api/orders/attach-tpsl-bracket-to-an-existing-order.md): Attaches a take-profit and/or stop-loss bracket to an existing filled or working parent order.
- [Cancel a pending order](https://docs.hyperprop.com/trade-api/orders/cancel-a-pending-order.md): Cancels a pending limit or stop order that has not yet been filled. Filled or already-cancelled orders cannot be cancelled.
- [Cancel all pending orders for an account](https://docs.hyperprop.com/trade-api/orders/cancel-all-pending-orders-for-an-account.md): Cancels every pending (working) order for the specified account in one operation. Filled orders are not affected.
- [Detach TP/SL bracket leg from an order](https://docs.hyperprop.com/trade-api/orders/detach-tpsl-bracket-leg-from-an-order.md): Removes the take-profit and/or stop-loss bracket from an existing parent order.
- [Get active working orders](https://docs.hyperprop.com/trade-api/orders/get-active-working-orders.md): Returns only the currently working (pending) limit and stop orders for the authenticated user.
- [Get all orders (filled, pending, cancelled)](https://docs.hyperprop.com/trade-api/orders/get-all-orders-filled-pending-cancelled.md): Returns the in-memory order list for the authenticated user across all their accounts.
- [Get command processing status by id](https://docs.hyperprop.com/trade-api/orders/get-command-processing-status-by-id.md): Returns the current processing state of a queued command (order submit, cancel, modify, flatten, etc.).
- [Get order history from database (append-only lifecycle events)](https://docs.hyperprop.com/trade-api/orders/get-order-history-from-database-append-only-lifecycle-events.md): Fetches order lifecycle events from the persistent database. Every status transition (submitted → working → filled, or submitted → cancelled) is recorded as a separate row.
- [Get trade execution history](https://docs.hyperprop.com/trade-api/orders/get-trade-execution-history.md): Returns all executed trades (fills) for the authenticated user.
- [Link a standalone order into the position's OCO group](https://docs.hyperprop.com/trade-api/orders/link-a-standalone-order-into-the-positions-oco-group.md): Adopts an existing standalone working limit order into the one-cancels-other (OCO) group of the open position on the same contract, as an additional take-profit.
- [Modify price or quantity of a pending order](https://docs.hyperprop.com/trade-api/orders/modify-price-or-quantity-of-a-pending-order.md): Modifies one or more fields of a pending limit or stop order: `price`, `quantity`, `take_profit`, `stop_loss`.
- [Submit a market, limit, or stop order](https://docs.hyperprop.com/trade-api/orders/submit-a-market-limit-or-stop-order.md): Submits an order to the command queue for processing. Returns a `command_id` you can use to track status.
- [Close a specific position by contract](https://docs.hyperprop.com/trade-api/positions/close-a-specific-position-by-contract.md): Closes the open position in the specified contract by submitting a market order in the opposite direction for the full quantity.
- [Close all open positions for an account](https://docs.hyperprop.com/trade-api/positions/close-all-open-positions-for-an-account.md): Closes every open position for the specified account by submitting market orders in the opposite direction.
- [Flatten account: close positions and cancel orders](https://docs.hyperprop.com/trade-api/positions/flatten-account:-close-positions-and-cancel-orders.md): The full "panic button": closes all open positions AND cancels all pending orders for the specified account(s).
- [Get open positions with real-time P&L](https://docs.hyperprop.com/trade-api/positions/get-open-positions-with-real-time-p&l.md): Returns all currently open positions for the authenticated user with real-time unrealized P&L.
- [Reverse a position (close + open opposite side)](https://docs.hyperprop.com/trade-api/positions/reverse-a-position-close-+-open-opposite-side.md): Closes the current position and opens a new position in the opposite direction with the same quantity.
- [Set TP/SL at the position level for one (account, contract) pair.](https://docs.hyperprop.com/trade-api/positions/set-tpsl-at-the-position-level-for-one-account-contract-pair.md): Use this instead of `attach-bracket` whenever the bracket should cover the **entire open position** (e.g., the user dragged the TP line on the chart). For multi-fill positions this attaches one bracket per parent entry order so the total bracket quantity equals the position quantity.
- [Read the trader's personal risk settings for an account.](https://docs.hyperprop.com/trade-api/risk/read-the-traders-personal-risk-settings-for-an-account.md)
- [Update personal risk settings.](https://docs.hyperprop.com/trade-api/risk/update-personal-risk-settings.md): Only the fields present in the body change. Values are clamped down to the firm's policy, and once the trader has locked settings for the day nothing that loosens risk is accepted until the next session.
- [Real-time WebSocket for trading events](https://docs.hyperprop.com/trade-api/websocket/real-time-websocket-for-trading-events.md): Upgrades to a WebSocket connection for streaming real-time trading events.

## OpenAPI Specs

- [md-openapi](https://docs.hyperprop.com/api-reference/md-openapi.json)
- [trade-openapi](https://docs.hyperprop.com/api-reference/trade-openapi.json)
- [openapi](https://docs.hyperprop.com/api-reference/openapi.json)