# Checkpoints

Handles all Security Token Checkpoints related functionality

## Hierarchy

* Namespace‹[SecurityToken](/polymesh-sdk-api-reference/docs-v7/classes/securitytoken.md)›

  ↳ **Checkpoints**

## Index

### Properties

* [context](/polymesh-sdk-api-reference/docs-v7/classes/checkpoints.md#protected-context)
* [parent](/polymesh-sdk-api-reference/docs-v7/classes/checkpoints.md#protected-parent)
* [schedules](/polymesh-sdk-api-reference/docs-v7/classes/checkpoints.md#schedules)

### Methods

* [create](/polymesh-sdk-api-reference/docs-v7/classes/checkpoints.md#create)
* [get](/polymesh-sdk-api-reference/docs-v7/classes/checkpoints.md#get)

## Properties

### `Protected` context

• **context**: [*Context*](/polymesh-sdk-api-reference/docs-v7/classes/context.md)

*Inherited from void*

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

### `Protected` parent

• **parent**: [*SecurityToken*](/polymesh-sdk-api-reference/docs-v7/classes/securitytoken.md)

*Inherited from void*

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

### schedules

• **schedules**: [*Schedules*](/polymesh-sdk-api-reference/docs-v7/classes/schedules.md)

*Defined in* [*src/api/entities/SecurityToken/Checkpoints/index.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/api/entities/SecurityToken/Checkpoints/index.ts#L23)

## Methods

### create

▸ **create**(`args`: void, `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v7/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v7/classes/transactionqueue.md)*‹*[*Checkpoint*](/polymesh-sdk-api-reference/docs-v7/classes/checkpoint.md)*››*

*Defined in* [*src/api/entities/SecurityToken/Checkpoints/index.ts:50*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/api/entities/SecurityToken/Checkpoints/index.ts#L50)

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](/polymesh-sdk-api-reference/docs-v7/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](/polymesh-sdk-api-reference/docs-v7/interfaces/procedureopts.md) |

**Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v7/classes/transactionqueue.md)*‹*[*Checkpoint*](/polymesh-sdk-api-reference/docs-v7/classes/checkpoint.md)*››*

### get

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

*Defined in* [*src/api/entities/SecurityToken/Checkpoints/index.ts:59*](https://github.com/PolymathNetwork/polymesh-sdk/blob/bf2b7a12/src/api/entities/SecurityToken/Checkpoints/index.ts#L59)

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](/polymesh-sdk-api-reference/docs-v7/interfaces/paginationoptions.md) |

**Returns:** *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v7/interfaces/resultset.md)*‹*[*CheckpointWithData*](/polymesh-sdk-api-reference/docs-v7/interfaces/checkpointwithdata.md)*››*


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.polymath.network/polymesh-sdk-api-reference/docs-v7/classes/checkpoints.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.