Investors, warrants & staking

Create Staking Request

Validates and creates a PENDING staking request for the caller's grant against the active staking configuration.

POSThttps://api.toku.com/platform/create-staking-request

Not available to API keys.

curl --request POST \
  --url 'https://api.toku.com/platform/create-staking-request' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "stakingAmount": "string",
  "grantID": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
200 response
{
  "isValid": true,
  "stakingRequest": {
    "stakingRequestID": "string",
    "stakingConfigurationID": "string",
    "roleInOrgID": "string",
    "stakingAmount": "string",
    "stakingBalance": "string",
    "stakingStartDate": "string",
    "stakingStatus": "DRAFT",
    "createdAt": "string",
    "grantID": "string",
    "updatedAt": "string",
    "stakingDistributionID": "string"
  },
  "message": "string"
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.

Body

application/json

stakingAmountstringrequired

NOTE(ck): a .refine() rule is not mirrored here; TGA still enforces it NOTE(ck): a .transform() rule is not mirrored here; TGA still enforces it

Allowed: matches ^\d+(?:\.\d+)?$

grantIDstring<uuid>required

Response

200Successful response
isValidbooleanrequired
stakingRequestobject | null
Show child attributes
stakingRequestIDstringrequired
stakingConfigurationIDstringrequired
roleInOrgIDstringrequired
stakingAmountstringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

stakingBalancestringrequired

Allowed: matches ^-?\d+(?:\.\d+)?(?:e[+-]?\d+)?$

stakingStartDatestringrequired
stakingStatusstringrequired

Available options: DRAFT, PENDING, APPROVED, REJECTED, CANCELLED, IN_STAKING, UNSTAKE_REQUEST_PLACED, STAKING_PERIOD_COMPLETED, COMPLETED

createdAtstringrequired
grantIDstringrequired
updatedAtstringrequired
stakingDistributionIDstring | nullrequired
messagestringrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits