# Checkpoints

Handles all Security Token Checkpoints related functionality

## Hierarchy

* Namespace‹[SecurityToken](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/securitytoken)›

  ↳ **Checkpoints**

## Index

### Properties

* [context](#protected-context)
* [parent](#protected-parent)
* [schedules](#schedules)

### Methods

* [create](#create)
* [get](#get)

## Properties

### `Protected` context

• **context**: [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/context)

*Inherited from void*

*Defined in* [*src/api/entities/Namespace.ts:11*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Namespace.ts#L11)

### `Protected` parent

• **parent**: [*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/securitytoken)

*Inherited from void*

*Defined in* [*src/api/entities/Namespace.ts:9*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Namespace.ts#L9)

### schedules

• **schedules**: [*Schedules*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/schedules)

*Defined in* [*src/api/entities/SecurityToken/Checkpoints/index.ts:22*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/SecurityToken/Checkpoints/index.ts#L22)

## Methods

### create

▸ **create**(`args`: void): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue)*‹*[*Checkpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/checkpoint)*››*

*Defined in* [*src/api/entities/SecurityToken/Checkpoints/index.ts:49*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/SecurityToken/Checkpoints/index.ts#L49)

Create a snapshot of Security Token holders and their respective balances at this moment

**`note`** required role:

* Security Token Owner

**`note`** this method is of type [ProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/proceduremethod), which means you can call `create.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name   | Type |
| ------ | ---- |
| `args` | void |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue)*‹*[*Checkpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/checkpoint)*››*

### get

▸ **get**(`paginationOpts?`: [PaginationOptions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/paginationoptions)): *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/resultset)*‹*[*CheckpointWithData*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/checkpointwithdata)*››*

*Defined in* [*src/api/entities/SecurityToken/Checkpoints/index.ts:58*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/SecurityToken/Checkpoints/index.ts#L58)

Retrieve all Checkpoints created on this Security Token, together with their corresponding creation Date and Total Supply

**`note`** supports pagination

**Parameters:**

| Name              | Type                                                                                                                     |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------ |
| `paginationOpts?` | [PaginationOptions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/paginationoptions) |

**Returns:** *Promise‹*[*ResultSet*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/resultset)*‹*[*CheckpointWithData*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/checkpointwithdata)*››*