Inkwell Finance Documentation

POST

api

ika

agent

allocate

Compute optimal allocation

curl --request POST \
  --url https://backend.inkwell.finance/api/v1/ika/agent/allocate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "amount": "10000000000",
  "maxValidators": 5
}
'

{
  "allocations": [
    {
      "validatorId": "<string>",
      "amount": "<string>",
      "weight": 123
    }
  ],
  "totalProjectedApy": 123
}

Authorizations

X-API-Key

string

header

required

Agent API key obtained via self-registration or admin registration

Body

application/json

amount

string

required

Amount of IKA in MIST to allocate

Example:

"10000000000"

maxValidators

integer

default:5

Required range: 1 <= x <= 10

Response

Optimal allocation

allocations

object[]

Show child attributes

totalProjectedApy

number

Build stake transactionReturns Move call parameters for staking IKA tokens with a specific validator. The caller signs and submits the transaction.

Compute optimal allocation

curl --request POST \
  --url https://backend.inkwell.finance/api/v1/ika/agent/allocate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "amount": "10000000000",
  "maxValidators": 5
}
'

{
  "allocations": [
    {
      "validatorId": "<string>",
      "amount": "<string>",
      "weight": 123
    }
  ],
  "totalProjectedApy": 123
}