Skip to navigation
Production API ReferenceAlgos

Create algo order

Create a new algo order

TWAP

TWAP orders break a large trade into smaller ones over time to reduce market impact:

  • Sub-orders are placed every 30 seconds.
  • Order duration is between 30 and 86,400 seconds, in multiples of 30.
  • Supported sub order type: MARKET

Authentication

Authorizationstring
API Key authentication via header

Request

Algo order content
algo_typestringRequired
Algo type, required for algo orders creation
duration_secondsintegerRequired
Duration in seconds for which the algo order will be running, required for algo orders creation
marketstringRequired
Market for which order is created
sideenumRequired
Algo order side
Allowed values:
signaturestringRequired

Order signature in as a string "[r,s]" signed by account's paradex private key

signature_timestampintegerRequired
Unix timestamp in milliseconds of order creation, used for signature verification
sizestringRequired
Size of the algo order
typeenumRequired
Algo order type, only MARKET is supported
dime_discountbooleanOptional

If true, child-order fees are charged in DIME with the DIME discount applied; falls back to USDC if balance is insufficient

frequencyintegerOptional

Interval in seconds between child orders (default: 30)

on_behalf_of_accountstringOptional
ID corresponding to the configured isolated margin account. Only for isolated margin orders
recv_windowintegerOptional
Order will be created if it is received by API within RecvWindow milliseconds from signature timestamp, minimum is 10 milliseconds

Response

Created
accountstringOptional

Account identifier (user's account address)

algo_paramsmap from strings to stringsOptional

Type-specific algo parameters

algo_typeenumOptional
Algo type
Allowed values:
avg_fill_pricestringOptional
Average fill price of the order
cancel_reasonstringOptional
Reason for algo cancellation if it was closed by cancel
created_atintegerOptional
Algo creation time
end_atintegerOptional
Algo end time
idstringOptional
Unique algo identifier
last_updated_atintegerOptional

Algo last update time. No changes once status=CLOSED

marketstringOptional
Market to which algo belongs
remaining_sizestringOptional
Remaining size of the algo
sideenumOptional
Algo side
Allowed values:
sizestringOptional
Algo size
statusenumOptional
Algo status
Allowed values:

Errors

400
Bad Request Error