limit_orders

Create Limit Order

Create a limit order.

post/v1/limit-orders

Request

Base URL
https://api.fereai.xyz
URL
https://api.fereai.xyz/v1/limit-orders
Auth
none declared

Query parameters

waitboolean

timeoutinteger

Seconds to block when wait=true (max 90; the ~100s edge cuts longer waits — use wait=false + poll for longer).

Request body

chain_id_ininteger required

Source chain ID.

chain_id_outinteger required

Destination chain ID.

token_instring required

Input token contract address.

token_outstring required

Output token contract address.

amountstring required

Amount in smallest unit (wei/lamports).

price_usd_triggernumber required

USD price that triggers the order execution.

trigger_token_addressstring required

Token address to monitor for the price trigger.

trigger_token_chainstring required

Chain of the trigger token (chain name or ID).

conditionstring required

Trigger condition: 'gte' (above price) or 'lte' (below price).

slippage_bpsinteger nullable

Slippage tolerance in basis points.

querystring nullable

Original user query for context.

Example request

{
  "amount": "1000000000000000000",
  "chain_id_in": 8453,
  "chain_id_out": 8453,
  "condition": "gte",
  "price_usd_trigger": 3500,
  "slippage_bps": 50,
  "token_in": "0xEeee...EEeE",
  "token_out": "0x8335...2913",
  "trigger_token_address": "0xEeee...EEeE",
  "trigger_token_chain": "base"
}

Response

Successful Response

task_idstring required

Celery task ID for tracking the async operation.

statusstring

Current task status: queued, pending, started.

poll_urlstring nullable

Relative URL to poll for task status.

notification_streamstring nullable

SSE stream URL for real-time task updates.

Example response

{
  "notification_stream": "/v1/notifications/stream",
  "poll_url": "/v1/tasks/d290f1ee-6c54-4b01-90e6-d701748f0851",
  "status": "queued",
  "task_id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}

Changes

No recorded changes to this operation across all 1 revision of this API.