Allocations

GET /api/allocations

Parameters:

• wallet (required) (query param) → the wallet address of the user, who connected their wallet on the claim-portal

Bad Responses:

• 400 → returned if the wallet is not provided

• 400 → returned if the claim window is not active

Ok Response:

The valid response contains a list of allocations. Each allocation has the following structure:

• id (uuid) → unique id of the distribution. Used in the following endpoints to identify a specific allocation for a user

• claimed (number) → the number of tokens that are already claimed by the user

• vested (number) → the number of tokens that are vested based on the schedule and the time of the request

• total (number) → the total allocation amount

• category (string | null) → the category of the allocation as seen in Magna. This field will only be returned for allocations added after May 30th and will be null for the older ones

• createdAt (string | null) → UTC timestamp of the allocation creation date on Magna. This field will only be returned for allocations added after May 30th and will be null for the older ones

Based on the above, the amount to claim can be calculated as vested - claimed

Example:

[
	{
		"id": "e6d77990-247d-4833-8d95-b57e1d76cf5f",
		"claimed": 1000,
		"vested": 3000,
		"total": 5000,
		"category": "Phase 1",
		"createdAt": "2024-05-29T01:09:11.000Z"
	}
]