Grants, vesting & distributions

Get Grant Overview Card

Builds a grant overview with vested/settled progress, tabbed detail rows and live price when the token is live.

GEThttps://api.toku.com/tga/get-grant-overview-card

Not available to API keys.

curl --request GET \
  --url 'https://api.toku.com/tga/get-grant-overview-card?grantID=%3CgrantID%3E' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "grantOverview": {
    "title": "string",
    "grantAssetType": "string",
    "vestingCards": [
      {
        "title": "string",
        "value": "string",
        "color": "string",
        "progress": 0,
        "type": "label"
      }
    ],
    "tablist": [
      {
        "key": "grantDetails",
        "tab": "Grant Details"
      }
    ],
    "tabs": {
      "grantDetails": [
        {
          "title": "string",
          "value": "string",
          "toolTipContent": "string"
        }
      ],
      "vestingAndSettlementDetails": [
        {
          "title": "string",
          "value": "string",
          "toolTipContent": "string"
        }
      ],
      "taxInformation": [
        {
          "title": "string",
          "value": "string",
          "toolTipContent": "string"
        }
      ]
    }
  },
  "vestingPeriodType": "MONTHLY",
  "tags": [
    "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.

Query parameters

grantIDstringrequired

Response

200Successful response
grantOverviewobjectrequired
Show child attributes
titlestringrequired
grantAssetTypestringrequired
vestingCardsobject[]required
Show child attributes
titlestringrequired
valuestring | numberrequired
colorstring
progressnumber | null
typestringrequired

Available options: label, badge, progress

tablistobject[]required
Show child attributes
keystringrequired

Available options: grantDetails, vestingAndSettlementDetails, taxInformation

tabstringrequired

Available options: Grant Details, Vesting And Settlement Details, Tax Information

tabsobjectrequired
Show child attributes
grantDetailsobject[]required
Show child attributes
titlestringrequired
valuestring | numberrequired
toolTipContentstring
vestingAndSettlementDetailsobject[]required
Show child attributes
titlestringrequired
valuestring | numberrequired
toolTipContentstring
taxInformationobject[]required
Show child attributes
titlestringrequired
valuestring | numberrequired
toolTipContentstring
vestingPeriodTypestring | nullrequired

Available options: MONTHLY, QUARTERLY, SEMIANNUALLY, YEARLY, CUSTOM, DAILY, WEEKLY, null

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