Allocations

The allocation object

The TokenOS distribution system is based upon the concept of allocations. An allocation represents an entry inside our distribution contract.

Once forged, an allocation (or airdrop) is immutable. It cannot be changed.

Retrieve allocation

Get one allocation detail

get

Authorizations

oAuthtokenIdHeader

OAuth2clientCredentialsRequired

Token URL:

Path parameters

allocationIdstringRequired

Responses

200

Ok

application/json

get

/allocations/{allocationId}

HTTPcURLJavaScriptPython

GET /v1/allocations/{allocationId} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Ok

{
  "id": "text",
  "status": "PENDING",
  "userId": "text",
  "amount": 1,
  "vesting": {
    "start": 1,
    "cliff": 1,
    "duration": 1
  },
  "deployment": {
    "recipient": "text",
    "transactionId": "text"
  }
}

Search for allocations

get

Authorizations

oAuthtokenIdHeader

OAuth2clientCredentialsRequired

Token URL:

Query parameters

userIdstringRequired

identifierTypestring · enumRequiredPossible values:

Responses

200

Allocations list

application/json

get

/allocations

HTTPcURLJavaScriptPython

GET /v1/allocations?userId=text&identifierType=email HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Allocations list

{
  "allocations": [
    {
      "id": "text",
      "status": "PENDING",
      "userId": "text",
      "amount": 1,
      "vesting": {
        "start": 1,
        "cliff": 1,
        "duration": 1
      },
      "deployment": {
        "recipient": "text",
        "transactionId": "text"
      }
    }
  ]
}

Transfer allocation to user's wallet

After the airdrop is created for a user, they must claim their airdrop - a process that requires the payment of gas fees.

If you would like to provide a more seamless experience for your users and directly deposit tokens into your users' wallets, you can use the following endpoint to pay the gas fees for the user's airdrop. This will require you to have ETH in a wallet, that you'll continuously need to top up as gas fees are paid.

Execute allocation for user, paying from your gas wallet

post

Authorizations

oAuthtokenIdHeader

OAuth2clientCredentialsRequired

Token URL:

Path parameters

allocationIdstringRequired

Responses

201

Accepted

post

/allocations/{allocationId}/transfer

HTTPcURLJavaScriptPython

POST /v1/allocations/{allocationId}/transfer HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

201

Accepted

No content