Idempotency

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": "..."}'

​

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.

​

Scope