Skip to main content
POST
Submit Order

Headers

PX-Key-Id
string
required

The key id issued for your signing keypair.

PX-Timestamp
string
required

Unix seconds at signing, valid within 30 seconds of the server clock.

PX-Signature
string
required

Ed25519 signature of the request

PX-Content-Sha256
string
required

Hex SHA-256 of the request body, or the SHA-256 of the empty string when there is no body.

Idempotency-Key
string
required

Idempotency key for this request. Re-sending the same key with the same body returns the original result and creates no duplicate; re-sending it with a different body is rejected with 422.

Minimum string length: 1
Example:

"2f1a8c4e-0b3d-4a9c-8e7f-1a2b3c4d5e6f"

Body

application/json
strikeId
string
required

The ProphetX strike to trade, which identifies both the market and the side.

Minimum string length: 1
Example:

"ab39fb9a7b4eb6a26d7e26f885c601c1"

price
string
required

Price in dollars per share, greater than 0 and less than 1, with at most six decimal places.

Example:

"0.413223"

quantity
number
required

Stake in account currency units.

Required range: x > 0
Example:

25

timeInForce
GoodTillCancelled · object

Execution policy; omission uses GTC.

postOnly
boolean

Rest as add-liquidity-only without taking existing liquidity.

Response

Order accepted; status is the order's recorded state, acceptance alone does not mean the order is resting or filled, and price is the order's resolved limit after ladder resolution rather than an execution or average fill price

orderId
string<uuid>
required

Issued order id.

Example:

"abd80630-5c89-437f-980e-47936f518ec2"

status
enum<string>
required

Order lifecycle status.

Available options:
PENDING,
SUBMITTED,
OPEN,
FILLED,
CANCELLED,
REJECTED
Example:

"OPEN"

price
string
required

Price in dollars per share, greater than 0 and less than 1, with at most six decimal places.

Example:

"0.413223"

venueOrderId
string | null
required

Venue order id for the order, or null when no venue order id is recorded.

Example:

"9f1a2b3c4d5e6f708192a3b4c5d6e7f8"

quantity
number
required

Stake the order was submitted with, in account currency units.

Required range: x > 0
Example:

25