v1

latestOpenAPI 3.0.1Apache 2.02026-07-26142209237.7 KB
Time Locks

getTimeLocksAll

Get time locks for all period. On Mina, some accounts have funds locked on their accounts. With time, they get unlocked either by vesting (gradually with time increments), or cliff mechanism (all at once).

post/v1/time-locks

Query parameters

pageinteger required

Queried API page.

sizeinteger required

Number of queried entries.

orderBy'ASC' | 'DESC' required

Sorting method: from the lowest element to the highest (ASC) or from the highest element to the lowest (DESC).

searchStrstring

Enter part or full account address to get its timelock data.

sortBy'INITIAL_MINIMUM_BALANCE' | 'UNLOCKED_PERCENT' | 'CLIFF_TIME' | 'CLIFF_AMOUNT' | 'VESTING_TIME' | 'VESTING_AMOUNT' | 'UNLOCKED_AMOUNT' | 'LOCK_DATE' | 'FULLY_UNLOCKED_DATE' | 'INITIAL_MINIMUM_BALANCE' | 'UNLOCKED_PERCENT' | 'CLIFF_TIME' | 'CLIFF_AMOUNT' | 'VESTING_TIME' | 'VESTING_AMOUNT' | 'UNLOCKED_AMOUNT' | 'LOCK_DATE' | 'FULLY_UNLOCKED_DATE' required

Select sorting parameter.

Request body

lockTypesstring[] required

Type of funds on the account balance: locked or unlocked.

Response

OK

currentPageinteger
sizeinteger
totalItemsinteger
totalPagesinteger
lastboolean
totalElementsinteger
numberinteger
firstboolean
numberOfElementsinteger
emptyboolean