Build an unsigned modification for a resting execution
const url = 'https://exec.predictefy.com/v1/exec/hyperliquid/orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/modify';const options = { method: 'POST', headers: { 'Idempotency-Key': 'example', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"price":1,"size":1,"trigger":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://exec.predictefy.com/v1/exec/hyperliquid/orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/modify \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: example' \ --data '{ "price": 1, "size": 1, "trigger": "example" }'Requires Authorization: Bearer <api-key> with the trade scope and a unique Idempotency-Key. The target must be submitted or acked, and the body must contain at least one of price, size, or trigger. The response is a new modify execution whose own executionId is submitted after client signing.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Execution venue slug. Availability is deployment-specific; discover armed lanes with GET /v1/exec/venues. Settlement-only lanes may appear but report order verbs false.
Account-owned execution UUID.
Header Parameters
Section titled “Header Parameters”Caller-generated non-empty key. Build/cancel/modify keys identify newly persisted intents; a submit key identifies that relay attempt and cannot be rebound to another ID.
Request Bodyrequired
Section titled “Request Bodyrequired”At least one supported modification must be present.
object
At least one supported modification must be present.
object
At least one supported modification must be present.
object
Examplegenerated
{ "price": 1, "size": 1, "trigger": "example"}Responses
Section titled “Responses”New unsigned modify execution. A duplicate key returns the original build.
object
object
acked means the venue accepted/relayed the artifact; it does not by itself prove the order is resting. Use the status/refresh operations for confirmation.
object
Fixed-point whole-contract count, for example 5.00.
Fixed-point whole-cent probability strictly between zero and one.
object
object
Validated client-signed or authless relayed artifact, or null before submission. Polymarket US submitted artifacts exclude keyId, secretKey, timestamp, and auth headers.
Venue fee estimate or null when no verified model is available.
Present on Hyperliquid HIP-4 order builds and their persisted responses.
object
First-party HIP-4 outcome assets have no perp-DEX component.
Optional pre-signing advisories. Polymarket and Opinion order builds currently warn that venue regional restrictions reject hosted submit from Predictefy’s relay egress. Rain order builds warn when a pool cannot prove its provenance against the source-verified official deployer. Hyperliquid warns when spendable spot USDC (total minus hold) is below order notional, names the shortfall, and points to POST /v1/funding/hyperliquid/steps; its balance read is fail-open. PRED declares a matching warning that venue key binding rejects platform-key submit for a caller-owned Safe maker, but no caller can currently receive it: the PRED lane is darked and unregistered, so its build route answers 404 before any warning is composed — the advisory applies only if that lane is re-armed. Builds and client signing remain available on the armed lanes; callers may use their own submit path or, for PRED, credentials from their own venue arrangement.
Example
{ "success": true, "data": { "intent": "order", "status": "built", "unsigned": { "side": "bid", "time_in_force": "good_till_canceled", "self_trade_prevention_type": "taker_at_cross" }, "collateral": { "ledger": "spot" } }}Headers
Section titled “Headers”Present with value true when stored state satisfied an idempotent retry.
Missing Idempotency-Key or an invalid request/body/lifecycle state.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}Missing, invalid, unknown, or revoked Predictefy API key.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}The request breaches a spend cap or the account lacks endpoint credits.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}The API key lacks trade scope or the venue geofence rejected the request.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}The venue lane is absent or the execution is missing/not owned by the caller.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}The authenticated execution token bucket is exhausted.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}Unexpected failure or an unsigned artifact escaped its registered bounds.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}The runtime venue lane does not implement this lifecycle verb.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}Authentication, billing, or execution storage is temporarily unavailable.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}