Skip to main content
PUT
Update your organization profile

Authorizations

X-API-Key
string
header
required

Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.

Headers

Idempotency-Key
string

Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with Idempotency-Replayed: true) instead of repeating the change. The same key with a different body returns 409 IDEMPOTENCY_KEY_REUSED; a retry while the first request is still running returns 409 IDEMPOTENCY_KEY_IN_PROGRESS. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns 409 IDEMPOTENCY_KEY_COMPLETED with the original status in originalStatus. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns 503 IDEMPOTENCY_UNAVAILABLE; retry with the same key.

Maximum string length: 255

Body

application/json
description
string

Brief description of your organization (shown to traders)

Example:

"Professional prop trading firm specializing in futures and forex"

contactEmail
string

Support email where traders can reach you

Example:

"support@example.com"

websiteUrl
string

Your organization website URL

Example:

"https://www.example.com"

logoUrl
string

A logo uploaded through the logo upload endpoint (images hosted elsewhere are refused)

Maximum string length: 2048
Example:

"https://cdn.example.com/logos/acme-trading.png"

sessionOpenDelayMinutes
integer

Minutes after CME session opens before trading is allowed (0 = trade immediately at open)

Required range: 0 <= x <= 120
Example:

15

sessionCloseBufferMinutes
integer

Minutes before CME session closes that trading stops (0 = trade until close)

Required range: 0 <= x <= 120
Example:

15

commissionPerSide
number

Commission per side in USD, max $100, 2 decimal places (e.g., 2.50 = $2.50 per side, $5.00 round trip)

Required range: 0 <= x <= 100
Example:

2

commissionPerSideMicro
number

Commission per side in USD for CME micro contracts (MES, MNQ, MGC, …). When set, micros are charged this rate instead of commissionPerSide. Set to null to remove and charge micros the flat rate again.

Required range: 0 <= x <= 100
Example:

0.5

commissionPerProduct
object

Per-product commission overrides, keyed by product code (e.g. ES, MES, NQ). The most specific rate wins: product override → micro rate → flat commissionPerSide. Replaces the whole map on update; set to null or {} to remove all overrides.

Example:
cryptoDayEndTime
string

Local time at which a 24/7 (crypto) trading day rolls over, HH:MM. This moves the daily loss limit and daily drawdown baseline and writes the day snapshot — it does NOT close the market and does NOT flatten positions, unlike the CME session close. Default 00:00.

Pattern: ^([01]\d|2[0-3]):[0-5]\d(:[0-5]\d)?$
Example:

"00:00"

cryptoDayEndTimezone
string

IANA timezone for cryptoDayEndTime, so the boundary follows daylight saving (e.g. America/New_York, UTC, Europe/London). Rejected with 400 if it is not a zone the runtime recognises. Default America/New_York.

Example:

"America/New_York"

perpCommissionMakerBps
number

Your commission on perpetual maker fills (a resting limit order that fills), in basis points of order value. Charged on top of the venue fee, the way commissionPerSide sits on top of the exchange fee on futures; per-contract commissions never apply to perpetuals. 1 = 0.01%. null = no commission.

Required range: 0 <= x <= 100
Example:

1

perpCommissionTakerBps
number

Your commission on perpetual taker fills (market, stop and marketable limit orders), in basis points of order value. Charged on top of the venue fee; per-contract commissions never apply to perpetuals. 2 = 0.02%. null = no commission.

Required range: 0 <= x <= 100
Example:

2

Response

Success - Profile updated. Returns the complete updated profile.

success
boolean
Example:

true

message
string
Example:

"Organization profile updated successfully"

data
object
Example: