Get Deallocation Status

Get the status of the last deallocation 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
• Minimum allocation: EEarnings:Below min:(De)allocation operation amount less than minimum

POST /private/Earn/DeallocateStatus

Get Deallocation Status

cURL

curl --request POST \
  --url https://api.kraken.com/0/private/Earn/DeallocateStatus \
  --header 'API-Key: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nonce": 30295839,
  "strategy_id": "ESRFUO3-Q62XD-WIOIL7"
}
'

200

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

Authorizations

API-Key · string · header · required

The "API-Key" header should contain your API key.

API-Sign · string · header · required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Body

application/json

nonce · integer<int64> · required

Nonce used in construction of API-Sign header

strategy_id · string · required

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

Response

200 - application/json

Response

error · string[]

Kraken API error

result · object

Status of async earn operation

Show child attributes