Get Allocation Status

POST 
/private/Earn/AllocateStatus

Get the status of the last allocation request.

Requires either the Earn Funds or Query Funds API key permission.

(De)allocation operations are asynchronous and this endpoint allows client to retrieve the status of the last dispatched operation. There can be only one (de)allocation request in progress for given user and strategy.

The pending attribute in the response indicates if the previously dispatched operation is still in progress (true) or has successfully completed (false). If the dispatched request failed with an error, then HTTP error is returned to the client as if it belonged to the original request.

Following specific errors within Earnings class can be returned by this method:

• Insufficient funds: EEarnings:Insufficient funds:Insufficient funds to complete the (de)allocation request
• User cap exceeded: EEarnings:Above max:The allocation exceeds user limit for the strategy
• Total cap exceeded: EEarnings:Above max:The allocation exceeds the total strategy limit
• Minimum allocation: EEarnings:Below min:(De)allocation operation amount less than minimum

Request

application/json

Body

required

nonce int64required

Nonce used in construction of API-Sign header

strategy_id stringrequired

ID of the earn strategy, call Earn/Strategies to list available strategies

Responses

200

Response

application/json

Schema

Schema

error string[]
result objectnullable

Status of async earn operation

pending boolean

true if an operation is still in progress on the same strategy.

Example (from schema)

{
  "error": [],
  "result": {
    "pending": false
  }
}

Loading...