Skip to main content
GET
/
api
/
v3
/
vesting
Get Vesting Contracts
curl --request GET \
  --url https://toncenter.com/api/v3/vesting
{
  "address_book": {},
  "vesting_contracts": [
    {
      "address": "<string>",
      "cliff_duration": 123,
      "owner_address": "<string>",
      "sender_address": "<string>",
      "start_time": 123,
      "total_amount": "<string>",
      "total_duration": 123,
      "unlock_period": 123,
      "whitelist": [
        "<string>"
      ]
    }
  ]
}

SDK Usage

import asyncio

from toncenter.rest import ToncenterRestClient
from toncenter.types import Network

WALLET_ADDRESS = ["UQCDrgGaI6gWK-qlyw69xWZosurGxrpRgIgSkVsgahUtxZR0"]


async def main() -> None:
    async with ToncenterRestClient(network=Network.MAINNET) as client:
        result = await client.v3.vesting.get_vesting_contracts(
            wallet_address=WALLET_ADDRESS,
        )
        print(result.model_dump_json(indent=4))


if __name__ == "__main__":
    asyncio.run(main())

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
default:10

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

offset
integer
default:0

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

Response

OK

address_book
object
vesting_contracts
object[]