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

GEThttp://localhost:8080/v1/allocations/{allocationId}

Authorization

oAuthtokenIdHeader

Path parameters

allocationId*string

Response

200

Ok

Body

application/json

idstring

statusenum

PENDINGDEPLOYABLEDEPLOYINGDEPLOYEDRELEASED

userIdstring

amountnumber (double)

vestingobject

deploymentobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('http://localhost:8080/v1/allocations/{allocationId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Search for allocations

GEThttp://localhost:8080/v1/allocations

Authorization

oAuthtokenIdHeader

Query parameters

Response

200

Allocations list

Body

application/json

allocationsarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('http://localhost:8080/v1/allocations?userId=text&identifierType=email', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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

POSThttp://localhost:8080/v1/allocations/{allocationId}/transfer

Authorization

oAuthtokenIdHeader

Path parameters

allocationId*string

Response

201

Accepted

Request

JavaScriptCurlPythonHTTP

const response = await fetch('http://localhost:8080/v1/allocations/{allocationId}/transfer', {
    method: 'POST',
    headers: {},
});
const data = await response.json();