Investors, warrants & staking

Get Staking Report

Builds a flattened staking report: requests with grant, recipient, configuration, last unlock date and current unstaking request.

POSThttps://api.toku.com/tga/get-staking-report

Not available to API keys yet. It will need grants:read.

curl --request POST \
  --url 'https://api.toku.com/tga/get-staking-report' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "orgID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "statusFilters": [
    "DRAFT"
  ]
}'
200 response
[
  {
    "stakingRequestID": "string",
    "stakingConfigurationID": "string",
    "roleInOrgID": "string",
    "stakingAmount": "string",
    "stakingBalance": "string",
    "stakingStartDate": "string",
    "stakingStatus": "DRAFT",
    "createdAt": "string",
    "grantID": "string",
    "updatedAt": "string",
    "stakingDistributionID": "string",
    "grant": {
      "grantName": "string",
      "grantID": "string",
      "grantAmount": "string",
      "vestingStartDate": "string",
      "vestingPeriods": "string",
      "lockups": [
        {}
      ]
    },
    "stakingConfiguration": {
      "stakingConfigurationID": "string",
      "cooldownPeriod": 0,
      "versionNumber": 0,
      "maxStakePercentage": "string",
      "stakingTypesEnabled": [
        "UNVESTED_LOCKED_TOKENS"
      ]
    },
    "unstakingRequests": [
      {
        "unstakingRequestID": "string",
        "stakingRequestID": "string",
        "unstakingAmount": "string",
        "unstakingDate": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "status": "DRAFT",
        "roleInOrgID": "string"
      }
    ],
    "roleInOrg": {
      "roleInOrgID": "string",
      "roleInOrgExternalID": 0,
      "person": {
        "fullName": "string"
      },
      "externalEmployeeID": "string",
      "employmentType": "string",
      "country": "string"
    },
    "grantName": "string",
    "grantAmount": "string",
    "fullName": "string",
    "roleInOrgExternalID": 0,
    "employmentType": "string",
    "externalEmployeeID": "string",
    "country": "string",
    "lastUnlockDate": "string",
    "currentUnstakingRequest": {
      "unstakingRequestID": "string",
      "stakingRequestID": "string",
      "unstakingAmount": "string",
      "unstakingDate": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "status": "DRAFT",
      "roleInOrgID": "string"
    },
    "maxStakePercentage": "string",
    "stakingTypesEnabled": [
      "UNVESTED_LOCKED_TOKENS"
    ],
    "cooldownPeriod": 0,
    "versionNumber": 0,
    "startDate": "string",
    "amount": "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

orgIDstring<uuid>
statusFiltersstring[]

Allowed: at most 20 items

Response

200Successful response
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
grantobjectrequired
Show child attributes
grantNamestringrequired
grantIDstringrequired
grantAmountstringrequired

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

vestingStartDatestringrequired
vestingPeriodsstring | nullrequired

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

lockupsobject[]required
stakingConfigurationobjectrequired
Show child attributes
stakingConfigurationIDstringrequired
cooldownPeriodintegerrequired
versionNumberintegerrequired
maxStakePercentagestringrequired

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

stakingTypesEnabledstring[]required
unstakingRequestsobject[]required
Show child attributes
unstakingRequestIDstringrequired
stakingRequestIDstringrequired
unstakingAmountstringrequired

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

unstakingDatestringrequired
createdAtstringrequired
updatedAtstringrequired
statusstringrequired

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

roleInOrgIDstringrequired
roleInOrgobjectrequired
Show child attributes
roleInOrgIDstringrequired
roleInOrgExternalIDintegerrequired
personobjectrequired
Show child attributes
fullNamestringrequired
externalEmployeeIDstring | nullrequired
employmentTypestring | nullrequired
countrystring | nullrequired
grantNamestringrequired
grantAmountstringrequired

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

fullNamestringrequired
roleInOrgExternalIDintegerrequired
employmentTypestring | nullrequired
externalEmployeeIDstring | nullrequired
countrystring | nullrequired
lastUnlockDatestring | nullrequired
currentUnstakingRequestobject
Show child attributes
unstakingRequestIDstringrequired
stakingRequestIDstringrequired
unstakingAmountstringrequired

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

unstakingDatestringrequired
createdAtstringrequired
updatedAtstringrequired
statusstringrequired

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

roleInOrgIDstringrequired
maxStakePercentagestringrequired

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

stakingTypesEnabledstring[]required
cooldownPeriodintegerrequired
versionNumberintegerrequired
requestTypeanyrequired
startDatestringrequired
amountstringrequired

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

400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits