---
title: "getTimeLocksYear"
method: GET
path: "/v1/time-locks/year"
tags: ["Time Locks"]
---

# getTimeLocksYear

`GET /v1/time-locks/year`

Get data about time locks by year. 
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).

## Query parameters

- `page` integer, required
- `size` integer, required
- `orderBy` 'ASC' | 'DESC', required
- `sortBy` 'TIMESTAMP' | 'UNLOCK' | 'CUMULATIVE_PERCENT_OF_TOTAL_LOCKS' | 'PERCENT_OF_TOTAL_LOCKS' | 'LOCK_AMOUNT' | 'TIMESTAMP' | 'UNLOCK' | 'CUMULATIVE_PERCENT_OF_TOTAL_LOCKS' | 'PERCENT_OF_TOTAL_LOCKS' | 'LOCK_AMOUNT', required
- `isLockedOnly` boolean, required

## Response `200`

OK

- RestResponsePageLocksYearEntity
  - `data` LocksYearEntity[]
    - `timestamp` integer
    - `unlock` number, double
    - `lockAmount` number, double
    - `unlockAmount` number, double
    - `percentOfTotalLocks` number, double
    - `cumulativePercentOfTotalLocks` number, double
  - `currentPage` integer
  - `size` integer
  - `totalItems` integer
  - `totalPages` integer
  - `content` LocksYearEntity[]
    - `timestamp` integer
    - `unlock` number, double
    - `lockAmount` number, double
    - `unlockAmount` number, double
    - `percentOfTotalLocks` number, double
    - `cumulativePercentOfTotalLocks` number, double
  - `pageable` PageableObject
    - `pageNumber` integer
    - `pageSize` integer
    - `offset` integer
    - `sort` SortObject
      - `sorted` boolean
      - `empty` boolean
      - `unsorted` boolean
    - `paged` boolean
    - `unpaged` boolean
  - `last` boolean
  - `totalElements` integer
  - `number` integer
  - `sort` SortObject
    - `sorted` boolean
    - `empty` boolean
    - `unsorted` boolean
  - `first` boolean
  - `numberOfElements` integer
  - `empty` boolean

---

[API](https://skmtc.net/blockberry/apis/sui-mainnet-api.md) · [All operations](https://skmtc.net/blockberry/apis/sui-mainnet-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/blockberry/sui-mainnet-api/versions/3e4cb73940b7/schema)