FEfereai
earn

Enable Yield

Enable yield (first deposit).

post/v1/earn/enable

Request

  • Base URL
    https://api.fereai.xyz
  • URL
    https://api.fereai.xyz/v1/earn/enable
  • 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

amount_usdcnumber required

Amount of USDC to deposit.

position_idstring nullable

Existing position ID to deposit into. Omit to create a new position.

Example request

{
  "amount_usdc": 100
}

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.