Inkwell Finance Documentation

POST

api

ika

agent

withdraw

Build withdraw transaction

curl --request POST \
  --url https://backend.inkwell.finance/api/v1/ika/agent/tx/withdraw \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "stakedIkaId": "<string>",
  "sender": "<string>"
}
'

{
  "target": "<string>",
  "arguments": [
    "<unknown>"
  ],
  "typeArguments": [
    "<string>"
  ]
}

Authorizations

X-API-Key

string

header

required

Agent API key obtained via self-registration or admin registration

Body

application/json

stakedIkaId

string

required

Object ID of the StakedIka NFT

Pattern: ^0x[a-f0-9]{64}$

sender

string

Response

Move call parameters

Parameters to construct a Sui Move call transaction. The caller signs and submits.

target

string

Move function target (e.g. package::module::function)

arguments

any[]

typeArguments

string[]

Compute rebalance planGiven current staking positions, computes the optimal rebalance steps (unstake from underperformers, stake to better validators). **Requires builder or pro tier.**

Build withdraw transaction

curl --request POST \
  --url https://backend.inkwell.finance/api/v1/ika/agent/tx/withdraw \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "stakedIkaId": "<string>",
  "sender": "<string>"
}
'

{
  "target": "<string>",
  "arguments": [
    "<unknown>"
  ],
  "typeArguments": [
    "<string>"
  ]
}