Get vesting contracts

Returns vesting contracts matching the specified filters. Filter by contract address or wallet address (owner or sender). Each result includes vesting schedule parameters: start time, cliff duration, total duration, unlock period, total amount, and optional whitelist.

GET /api/v3/vesting

Get vesting contracts

cURL

curl --request GET \
  --url https://toncenter.com/api/v3/vesting

200

{
  "address_book": {},
  "vesting_contracts": [
    "<unknown>"
  ]
}

Query Parameters

contract_address · string[]

Vesting contract address in any form. Max: 1000.

wallet_address · string[]

Wallet address to filter by owner or sender. Max: 1000.

check_whitelist · boolean · default: false

Check if wallet address is in whitelist.

limit · integer<int32> · default: 10

Limit number of queried rows. Use with offset to batch read.

Required range: 1 <= x <= 1000

offset · integer<int32> · default: 0

Skip first N rows. Use with limit to batch read.

Required range: x >= 0

Response

200 - application/json

Matching vesting contracts with address book.

Response wrapper containing vesting contracts with address book.

address_book · object

Address book mapping raw addresses to user-friendly forms for all addresses referenced in the response.

Show child attributes

vesting_contracts · any[]

Array of vesting contracts matching the query filters.