Get allocation details by uid



Request headers are required. See API basics introduction for more information.

Get allocation details by uid


GET /reward/allocation/{uid}

Returns the allocation details for a given uid associated with the given App (set by the X-API-KEY).


Path parameters

Path parameterDescription
uidThe unique identifier of the Allocation for this app (ex. 213134081289).


You will receive the allocation details including the following fields:

Response fieldsTypeDescriptionCondition
uidStringThe UID of the allocation.Mandatory
statusStringThe status of the allocation (pending | done).Mandatory
reward_uidStringThe UID of the reward associated.Mandatory
to_user_uidStringThe UID of the user to who the rewards are allocated.Mandatory
amountStringThe amount of rewards allocatedMandatory
nonceStringThe unique ID of the allocation that was givenMandatory
The timestamp of the allocation creation.Mandatory

Response example

  "success": true,
  "data": {
    "uid": "213134081289",
    "status": "Pending",
    "reward_uid": "112144981245",
    "to_user_uid": "223144788242",
    "amount": "1.23",
    "nonce": "nonce_1",
    "created_at": "2023-08-10T14:07:14.494142Z",


The following example gets the allocation details for allocation 333333333333.

# API_KEY is your api key
# TOKEN is the access token generated with your api key secret

curl -i \
  -X GET \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: API_KEY" \
  -H "Authorization: Bearer TOKEN" \