# Checkpoints

Handles all Security Token Checkpoints related functionality

## Hierarchy

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

  ↳ **Checkpoints**

## Index

### Properties

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

### Methods

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

## Properties

### `Protected` context

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

*Inherited from void*

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

***

### `Protected` parent

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

*Inherited from void*

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

***

### schedules

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

*Defined in* [*src/api/entities/SecurityToken/Checkpoints/index.ts:36*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/SecurityToken/Checkpoints/index.ts#L36)

## Methods

### create

▸ **create**(`args`: void, `opts?`: [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v13/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/transactionqueue)*‹*[*Checkpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/checkpoint)*››*

*Defined in* [*src/api/entities/SecurityToken/Checkpoints/index.ts:60*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/SecurityToken/Checkpoints/index.ts#L60)

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

**`note`** this method is of type [ProcedureMethod](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v13/docs/interfaces/proceduremethod.md), 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                                                                                                            |
| `opts?` | [ProcedureOpts](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v13/docs/interfaces/procedureopts.md) |

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

***

### get

▸ **get**(`paginationOpts?`: [PaginationOptions](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v13/docs/interfaces/paginationoptions.md)): *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v13/docs/interfaces/resultset.md)*‹*[*CheckpointWithData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v13/docs/interfaces/checkpointwithdata.md)*››*

*Defined in* [*src/api/entities/SecurityToken/Checkpoints/index.ts:94*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/SecurityToken/Checkpoints/index.ts#L94)

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://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v13/docs/interfaces/paginationoptions.md) |

**Returns:** *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v13/docs/interfaces/resultset.md)*‹*[*CheckpointWithData*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v13/docs/interfaces/checkpointwithdata.md)*››*

***

### getOne

▸ **getOne**(`args`: object): *Promise‹*[*Checkpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/checkpoint)*›*

*Defined in* [*src/api/entities/SecurityToken/Checkpoints/index.ts:69*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/SecurityToken/Checkpoints/index.ts#L69)

Retrieve a single Checkpoint for this Security Token by its ID

**`throws`** if there is no Checkpoint with the passed ID

**Parameters:**

▪ **args**: *object*

| Name | Type      |
| ---- | --------- |
| `id` | BigNumber |

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