> ## 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. # Reconcile a trading day in one call > One call, everything you need to reconcile a trading day — collapses the separate `/snapshots/accounts` + `/snapshots/fills` requests you previously had to stitch together. **Per account you get:** - `endOfDay` — the immutable EOD snapshot: status (with `previousStatus` / `statusChanged` / `violationReason`), starting/ending balances, daily and total P&L, high water mark, fill count, contracts traded, first/last fill. - `current` — the account's status and balance **right now**, so you can spot post-EOD changes at a glance. - `fills` — every fill of that CME trading day, in order, with price, fees, commission, and realized P&L per fill. Omit with `?includeFills=false`. - `customerId` and `userId` for deterministic mapping to your records. **Defaults for a clean daily job:** with no `tradingDay`, the endpoint uses `latestCompletedTradingDay` automatically — so a scheduled `GET /reconciliation` (or one triggered by the `snapshot.ready` webhook) always reconciles the most recent finished day, never an empty in-progress one. **Ordering:** accounts are sorted by account number; pages are deterministic. **Example:** ```http GET /organization/reconciliation?tradingDay=2026-07-22&accountId=, ``` **Permissions:** requires **view** access to "Analytics". ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/reconciliation 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 Two methods, depending on who is calling: ### Bearer Token (JWT) — users & dashboard Most endpoints accept a JWT via `Authorization: Bearer `. Used by the dashboard and client applications. ### API Key — organizations (prop firms) Organization endpoints also accept `X-API-Key: hp_live_...` for programmatic access from your backend — no browser session needed. Keys are managed by organization admins in the dashboard; each key carries permissions (`read`, `write`, `admin`) and can be rotated or revoked at any time. Keys are stored hashed (SHA-256) — the raw key is shown once at creation. Endpoints that create or modify data require `write` or `admin`. ## Quick Start ```bash # 1. List your trading plans (grab a tradingPlanId) curl "https://api.hyperprop.com/platform/v1/organization/trading-plans" \ -H "X-API-Key: hp_live_your_key_here" # 2. Create a trading account for a trader (by Hyperprop user ID or email) curl -X POST "https://api.hyperprop.com/platform/v1/organization/trading-accounts" \ -H "X-API-Key: hp_live_your_key_here" \ -H "Content-Type: application/json" \ -d '{"type": "evaluation", "tradingPlanId": "", "email": "trader@example.com"}' ``` ## Response Envelope & Error Handling **Success** responses always wrap the payload: ```json { "success": true, "data": { ... }, "message": "optional human-readable note" } ``` **Errors** — including request-validation failures, auth failures, and errors proxied from the trade engine — always return this single uniform shape with a machine-readable `code` you can switch on: ```json { "success": false, "statusCode": 404, "error": "Not Found", "message": "No Hyperprop user found with that email. The trader must have a Hyperprop account before an account can be created for them.", "code": "TRADER_NOT_FOUND" } ``` Parse rule of thumb: check `success`; on `false`, switch on `code` (never on `message` text — messages can be reworded). Some errors carry additional structured context alongside these fields (e.g. payout rejections include a `consistency` block). Common codes: `VALIDATION_ERROR` (malformed payload/params), `UNAUTHORIZED`, `INSUFFICIENT_PERMISSIONS` / `NOT_ADMIN` (key lacks write/admin), `*_NOT_FOUND` (missing resource), `*_NOT_IN_ORG` (resource belongs to another organization), `IDEMPOTENCY_KEY_IN_PROGRESS` (duplicate in flight), `ENGINE_UNREACHABLE` (trade engine down — retry with the same idempotency key). Endpoint-specific codes (e.g. payout `OPEN_EXPOSURE`, `CONSISTENCY_BLOCKED`) are documented on each endpoint. ## Idempotency **Every mutating endpoint (POST, PUT, PATCH, DELETE) honors idempotency keys uniformly.** Send an `Idempotency-Key` header (the `X-Idempotency-Key` spelling is accepted as an alias) to retry any write safely without creating duplicates. How it works: - The key is scoped to your organization + the request path. The first request with a given key executes normally and its response is cached for **24 hours**. - A replay (same key, same path) within 24 hours returns the cached response with an `Idempotency-Replayed: true` response header — the operation is **not** executed again. - If a request with the same key is still in flight, the duplicate gets `409 IDEMPOTENCY_KEY_IN_PROGRESS` — back off and retry; you'll then receive the cached response. - 5xx responses are **not** cached, so retrying after a server error re-executes the request (that's what you want). 2xx-4xx responses are cached — if a request failed validation and you fix the payload, use a **fresh key**. - Keys are free-form strings up to 255 characters. Use something that identifies the operation on your side, e.g. `order-8814-attempt-1`. ```bash curl -X POST "https://api.hyperprop.com/platform/v1/organization/trading-accounts" \ -H "X-API-Key: hp_live_your_key_here" \ -H "Idempotency-Key: order-8814-attempt-1" \ -H "Content-Type: application/json" \ -d '{"type": "evaluation", "tradingPlanId": "...", "traderId": "..."}' ``` This applies to account creation, account PATCH (status, currentBalance, metadata), rules, plans, lockouts, payouts, team, webhooks — every write on the platform API. Payouts additionally forward the key to the trade engine for engine-level double-withdrawal protection. ## Pagination & Sorting List endpoints support both styles: - **Cursor (recommended):** pass `?cursor=` from the previous response's `pagination.nextCursor`. Stable under concurrent writes. - **Offset:** `?limit=&offset=` with `pagination.total` / `hasMore` in the response. Sorting uses `?sort=field:direction` (e.g. `?sort=created_at:asc`); allowed fields are listed per endpoint. Default: `created_at:desc`. ## Custom Metadata Trading accounts, purchases, traders, plans, and rules all carry a free-form `metadata` JSON object. Use it to store your own references — payment IDs, campaign tags, payout records, internal notes. Hyperprop stores and returns it verbatim (and lets you filter list endpoints by it, e.g. `?metadata=stripePaymentId:pi_123`) but never interprets it. Update endpoints support `mergeMetadata: true` for shallow (top-level) merges instead of wholesale replacement. ## Webhooks Subscribe to account lifecycle events (`account.created`, `account.status_changed`, `account.updated`, `account.passed`, `account.failed`, and more) via the Webhooks endpoints. Deliveries are HMAC-SHA256 signed — verify `X-Hyperprop-Signature` with your endpoint secret, using `X-Hyperprop-Timestamp` for replay protection; `X-Hyperprop-Delivery` gives you a unique delivery ID for deduplication. Failed deliveries are retried with backoff, and you can redeliver any event from the dashboard or API. ## MCP Connector (AI Agents) The platform ships a built-in [MCP](https://modelcontextprotocol.io) server, so AI agents and assistants (Claude, Cursor, custom agents) can operate your organization directly — no integration code required. ```http Endpoint: POST https://api.hyperprop.com/platform/v1/mcp Transport: Streamable HTTP (stateless, JSON responses) Auth: X-API-Key header, Authorization: Bearer hp_live_..., or OAuth ``` **Claude web / desktop (Add custom connector):** paste the endpoint URL and leave the OAuth Client ID/Secret fields empty — the connector registers itself automatically. Claude opens a Hyperprop consent page where an org admin pastes the organization API key once; access then follows that key's permissions and ends if the key is revoked. (Under the hood: OAuth 2.1 with PKCE and dynamic client registration.) **Cursor / Claude Code — `mcp.json`:** ```json { "mcpServers": { "hyperprop": { "url": "https://api.hyperprop.com/platform/v1/mcp", "headers": { "X-API-Key": "hp_live_your_key_here" } } } } ``` **Available tools (12):** `list_trading_plans`, `list_trading_accounts`, `get_trading_account`, `get_account_audit_log`, `list_traders`, `get_trader`, `list_purchases`, `get_purchase`, `get_billing_summary` (read) · `create_trading_account`, `update_trading_account`, `record_payout` (write). Every tool call executes the corresponding REST endpoint with your key, so organization scoping, permissions, validation, audit logging, and webhooks apply exactly as documented on each endpoint. Read tools work with any key; write tools need `write`/`admin` permission — connect a **read-only key** if you want a strictly read-only agent. `create_trading_account` accepts an optional `idempotencyKey` so agent retries can't create duplicates, and `record_payout` implements the documented payout recipe (append to `metadata.payouts`, adjust `currentBalance`, audit-logged `reason`). ## Endpoint Groups - **Authentication** — Sign up, sign in, OAuth, MFA, password reset. No auth required for most. - **User** — Profile, notifications, demo accounts, audit logs. Requires **Bearer token** (JWT). - **Organization** — Trading accounts, plans, rules, traders, purchases, lockouts, billing, bulk operations, webhooks, analytics. Accepts **Bearer token** OR **API Key**. - **System** — Health checks. No auth required. 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: Authentication description: >- User authentication - signup, signin, signout, password reset, email verification, OAuth, and MFA - name: User description: >- User account management - profile, notifications, agreements, dismissals, and audit logs. Requires Bearer token. - name: Organization description: >- Organization management - profile, team, trading accounts, plans, and rules. Supports **dual authentication**: Bearer JWT token (dashboard users) OR X-API-Key (programmatic access). - name: Demo description: >- Demo account management - import, list, and delete demo trading accounts. Requires Bearer token. - name: Market Data description: CME futures contracts and market data. Requires Bearer token. - name: System description: System endpoints - health checks and connectivity paths: /v1/organization/reconciliation: get: tags: - Organization summary: Reconcile a trading day in one call description: >- One call, everything you need to reconcile a trading day — collapses the separate `/snapshots/accounts` + `/snapshots/fills` requests you previously had to stitch together. **Per account you get:** - `endOfDay` — the immutable EOD snapshot: status (with `previousStatus` / `statusChanged` / `violationReason`), starting/ending balances, daily and total P&L, high water mark, fill count, contracts traded, first/last fill. - `current` — the account's status and balance **right now**, so you can spot post-EOD changes at a glance. - `fills` — every fill of that CME trading day, in order, with price, fees, commission, and realized P&L per fill. Omit with `?includeFills=false`. - `customerId` and `userId` for deterministic mapping to your records. **Defaults for a clean daily job:** with no `tradingDay`, the endpoint uses `latestCompletedTradingDay` automatically — so a scheduled `GET /reconciliation` (or one triggered by the `snapshot.ready` webhook) always reconciles the most recent finished day, never an empty in-progress one. **Ordering:** accounts are sorted by account number; pages are deterministic. **Example:** ```http GET /organization/reconciliation?tradingDay=2026-07-22&accountId=, ``` **Permissions:** requires **view** access to "Analytics". operationId: getV1OrganizationReconciliation parameters: - description: >- CME trading day (YYYY-MM-DD). Defaults to the latest COMPLETED trading day — the natural reconciliation target. name: tradingDay in: query required: false schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ - description: >- Scope to specific accounts: one account UUID or a comma-separated list (max 100). IDs outside your organization return 404 ACCOUNT_NOT_FOUND. name: accountId in: query required: false schema: type: string - description: >- Include every fill of the day per account (default true). Set false for a lighter balances-only response. name: includeFills in: query schema: type: boolean default: true - description: 'Accounts per page (default: 50, max: 100)' name: limit in: query schema: type: integer minimum: 1 maximum: 100 default: 50 - description: Pagination offset name: offset in: query schema: type: integer minimum: 0 default: 0 responses: '200': description: Reconciliation data retrieved content: '*/*': schema: $ref: '#/components/schemas/Model90' '401': description: Authentication required content: '*/*': schema: $ref: '#/components/schemas/Model7' '404': description: Not Found - unknown accountId, or no completed snapshots exist yet content: '*/*': schema: $ref: '#/components/schemas/Model91' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model3' security: - Bearer: [] - X-API-Key: [] components: schemas: Model90: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model89' Model7: 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 Model91: type: object properties: statusCode: type: number example: 404 error: type: string example: Not Found message: type: string example: >- Account(s) not found in your organization: 7c9e6679-7425-40de-944b-e07fc1f90ae7 code: type: string example: ACCOUNT_NOT_FOUND Model3: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: An unexpected error occurred code: type: string description: Machine-readable error code — switch on this, not on message text example: INTERNAL_ERROR Model89: type: object example: tradingDay: '2026-07-22' latestCompletedTradingDay: '2026-07-22' organizationId: a6fcc0ce-eb28-4f43-b256-96a3144b0d34 organizationName: FakePropFirm accounts: - accountId: 7c9e6679-7425-40de-944b-e07fc1f90ae7 accountNumber: ACC-ABCD1234 customerId: mffu-cust-4471 externalRef: mffu-cust-4471 type: evaluation userId: f994bc02-343c-4026-8a57-afc085eca8d5 endOfDay: status: in_progress statusChanged: false previousStatus: null violationReason: null initialBalance: 50000 startingBalance: 50250 endingBalance: 50875 dailyPnl: 625 totalPnl: 875 highWaterMark: 50900 totalFills: 2 totalContractsTraded: 4 firstFillAt: '2026-07-22T14:30:01Z' lastFillAt: '2026-07-22T20:45:12Z' current: status: in_progress balance: 50875 fills: - id: 0d1e6679-7425-40de-944b-e07fc1f90ae9 contract: MNQU6 product: MNQ symbol: MNQ side: buy orderType: market quantity: 2 filledQuantity: 2 filledPrice: 21150.25 fee: 0.74 commission: 0.5 realizedPnl: null filledAt: '2026-07-22T14:30:01Z' pagination: total: 142 limit: 50 offset: 0 hasMore: true properties: tradingDay: type: string example: '2026-07-22' latestCompletedTradingDay: type: string organizationId: type: string organizationName: type: string accounts: $ref: '#/components/schemas/Model87' pagination: $ref: '#/components/schemas/Model88' Model87: type: array items: $ref: '#/components/schemas/Model86' Model88: type: object properties: total: type: number limit: type: number offset: type: number hasMore: type: boolean Model86: type: object properties: accountId: type: string accountNumber: type: string customerId: type: string description: Your customer ID for this account externalRef: type: string description: DEPRECATED alias for customerId (same value) type: type: string userId: type: string endOfDay: $ref: '#/components/schemas/endOfDay' current: $ref: '#/components/schemas/current' fills: $ref: '#/components/schemas/fills' endOfDay: type: object properties: status: type: string statusChanged: type: boolean previousStatus: type: string violationReason: type: string initialBalance: type: number startingBalance: type: number endingBalance: type: number dailyPnl: type: number totalPnl: type: number highWaterMark: type: number totalFills: type: number totalContractsTraded: type: number firstFillAt: type: string lastFillAt: type: string current: type: object properties: status: type: string description: Account status right now (may differ from EOD) balance: type: number description: Account balance right now fills: type: array items: $ref: '#/components/schemas/Model85' Model85: type: object properties: id: type: string contract: type: string product: type: string symbol: type: string side: type: string orderType: type: string quantity: type: number filledQuantity: type: number filledPrice: type: number fee: type: number commission: type: number realizedPnl: type: number filledAt: type: string securitySchemes: Bearer: type: apiKey name: Authorization in: header description: >- JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints. X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key for programmatic access. Format: "hp_live_{key}". Used by Organization endpoints as an alternative to Bearer token. Keys are managed in the dashboard. ```` ## Related topics - [Consistency status for one of the caller's accounts](/trade-api/accounts/consistency-status-for-one-of-the-callers-accounts.md) - [Time Machine — bulk revert accounts to a trading day](/platform-api/organization/time-machine-—-bulk-revert-accounts-to-a-trading-day.md) - [Time Machine — revert an account to a trading day](/platform-api/organization/time-machine-—-revert-an-account-to-a-trading-day.md) - [Get fills for a trading day](/platform-api/organization/get-fills-for-a-trading-day.md) - [Introduction](/introduction.md)