> ## 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. # Look up an idempotency key > Shows what happened to a request you sent with an `Idempotency-Key`: whether it completed (and the response it returned), is still in progress, or is not on record. Use it when a request timed out on your side and a retry with the same key returns `409 IDEMPOTENCY_KEY_IN_PROGRESS`: - **`completed`**: the request took effect. `response` holds its status code and body, the same response a retry with the key returns. Don't send it with a new key. - **`in_progress`** with `stale: false`: the request may still be running. Wait and look again. - **`in_progress`** with `stale: true`: no response was recorded within 120 seconds, so the request most likely stopped before finishing. It may or may not have taken effect. Check the result directly (for example list the trader's accounts), then release the key with `POST /organization/idempotency-keys/release` and retry. - **`not_found`**: nothing is on record for this key on this endpoint (never sent, or expired after 24 hours). You can send the request with it. Keys belong to the caller that sent them: look a key up with the same API key (or the same signed-in member) that sent the request, and give the same `method` and `path`. Requires the permission the original endpoint needs. ```bash curl "https://api.hyperprop.com/platform/v1/organization/idempotency-keys?key=acme-order-20058745&method=POST&path=/platform/v1/organization/trading-accounts" \ -H "X-API-Key: hp_live_your_key_here" ``` ## OpenAPI ````yaml https://api.hyperprop.com/platform/openapi.json get /v1/organization/idempotency-keys 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: 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/idempotency-keys: get: tags: - Logs and health summary: Look up an idempotency key description: >- Shows what happened to a request you sent with an `Idempotency-Key`: whether it completed (and the response it returned), is still in progress, or is not on record. Use it when a request timed out on your side and a retry with the same key returns `409 IDEMPOTENCY_KEY_IN_PROGRESS`: - **`completed`**: the request took effect. `response` holds its status code and body, the same response a retry with the key returns. Don't send it with a new key. - **`in_progress`** with `stale: false`: the request may still be running. Wait and look again. - **`in_progress`** with `stale: true`: no response was recorded within 120 seconds, so the request most likely stopped before finishing. It may or may not have taken effect. Check the result directly (for example list the trader's accounts), then release the key with `POST /organization/idempotency-keys/release` and retry. - **`not_found`**: nothing is on record for this key on this endpoint (never sent, or expired after 24 hours). You can send the request with it. Keys belong to the caller that sent them: look a key up with the same API key (or the same signed-in member) that sent the request, and give the same `method` and `path`. Requires the permission the original endpoint needs. ```bash curl "https://api.hyperprop.com/platform/v1/organization/idempotency-keys?key=acme-order-20058745&method=POST&path=/platform/v1/organization/trading-accounts" \ -H "X-API-Key: hp_live_your_key_here" ``` operationId: getV1OrganizationIdempotencykeys parameters: - description: The `Idempotency-Key` value you sent name: key in: query required: true schema: type: string minLength: 1 maxLength: 255 - description: HTTP method of the original request x-convert: case: upper name: method in: query schema: type: string enum: - POST - PUT - PATCH - DELETE default: POST - description: >- Path of the original request, as sent (`/platform/v1/organization/...`; a path starting at `/v1/` also works). No query string. name: path in: query required: true schema: type: string minLength: 1 maxLength: 500 responses: '200': description: Success - The key and what happened to its request content: '*/*': schema: $ref: '#/components/schemas/Model129' '400': description: >- Bad Request - Invalid query or body (`VALIDATION_ERROR`), or `path` is not an organization endpoint (`INVALID_PATH`) content: '*/*': schema: $ref: '#/components/schemas/Model131' '401': description: Authentication required content: '*/*': schema: $ref: '#/components/schemas/Model11' '403': description: >- Forbidden - Your role or API key lacks the permission the original endpoint needs content: '*/*': schema: $ref: '#/components/schemas/Model132' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model6' '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/Model133' security: - X-API-Key: [] components: schemas: Model129: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model128' Model131: type: object properties: success: type: boolean example: false statusCode: type: number example: 400 error: type: string example: Bad Request message: type: string example: >- `path` must be the organization endpoint the key was sent to, for example /platform/v1/organization/trading-accounts code: $ref: '#/components/schemas/Model130' Model11: 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 Model132: type: object properties: success: type: boolean example: false statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: Your role does not have write access to "Traders & accounts" code: type: string example: INSUFFICIENT_PERMISSIONS Model6: 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 Model133: 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 Model128: type: object properties: key: type: string example: acme-order-20058745 method: type: string example: POST path: type: string example: /platform/v1/organization/trading-accounts state: $ref: '#/components/schemas/state' startedAt: type: string description: When the first request with this key arrived example: '2026-10-21T13:37:10.000Z' expiresAt: type: string description: When the key expires and can be used again for a new request example: '2026-10-22T13:37:10.000Z' stale: type: boolean description: >- True when the key has been in progress for more than 120 seconds: the request most likely stopped before finishing, and the key can be released example: true releasableAt: type: string description: For an in-progress key, when it can be released example: '2026-10-21T13:39:10.000Z' response: $ref: '#/components/schemas/response' Model130: type: string example: INVALID_PATH enum: - VALIDATION_ERROR - INVALID_PATH state: type: string description: >- `completed`: the request finished and `response` is what it returned. `in_progress`: no response was recorded yet. `not_found`: no request with this key is on record (never sent, or expired after 24 hours), so the key is free to use. example: in_progress enum: - completed - in_progress - not_found response: type: object description: >- For a completed key, the stored outcome (the same response a retry with the key returns) properties: statusCode: type: integer example: 201 body: type: string description: The response body the request returned 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 - [Idempotency](https://docs.hyperprop.com/concepts/idempotency.md) - [Release a stuck idempotency key](https://docs.hyperprop.com/platform-api/logs-and-health/release-a-stuck-idempotency-key.md) - [Custom metadata](https://docs.hyperprop.com/concepts/metadata.md) - [Introduction](https://docs.hyperprop.com/introduction.md) - [Reverse a payout (restore the withdrawn balance)](https://docs.hyperprop.com/platform-api/payouts/reverse-a-payout-restore-the-withdrawn-balance.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.