> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymesh-sdk-api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/venue.md).

# Venue

Represents a Venue through which settlements are handled

## Hierarchy

* [Entity](/polymesh-sdk-api-reference/docs-v5/classes/entity.md)‹UniqueIdentifiers›

  ↳ **Venue**

## Index

### Properties

* [addInstruction](/polymesh-sdk-api-reference/docs-v5/classes/venue.md#addinstruction)
* [addInstructions](/polymesh-sdk-api-reference/docs-v5/classes/venue.md#addinstructions)
* [context](/polymesh-sdk-api-reference/docs-v5/classes/venue.md#protected-context)
* [id](/polymesh-sdk-api-reference/docs-v5/classes/venue.md#id)
* [modify](/polymesh-sdk-api-reference/docs-v5/classes/venue.md#modify)
* [uuid](/polymesh-sdk-api-reference/docs-v5/classes/venue.md#uuid)

### Methods

* [details](/polymesh-sdk-api-reference/docs-v5/classes/venue.md#details)
* [exists](/polymesh-sdk-api-reference/docs-v5/classes/venue.md#exists)
* [getPendingInstructions](/polymesh-sdk-api-reference/docs-v5/classes/venue.md#getpendinginstructions)
* [isEqual](/polymesh-sdk-api-reference/docs-v5/classes/venue.md#isequal)
* [generateUuid](/polymesh-sdk-api-reference/docs-v5/classes/venue.md#static-generateuuid)
* [unserialize](/polymesh-sdk-api-reference/docs-v5/classes/venue.md#static-unserialize)

## Properties

### addInstruction

• **addInstruction**: *ProcedureMethod‹*[*AddInstructionParams*](/polymesh-sdk-api-reference/docs-v5/interfaces/addinstructionparams.md)*,* [*Instruction*](/polymesh-sdk-api-reference/docs-v5/classes/instruction.md)*\[],* [*Instruction*](/polymesh-sdk-api-reference/docs-v5/classes/instruction.md)*›*

*Defined in* [*src/api/entities/Venue/index.ts:196*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Venue/index.ts#L196)

Creates a settlement Instruction in this Venue

**`param`** array of token movements (amount, from, to, token)

**`param`** date at which the trade was agreed upon (optional, for offchain trades)

**`param`** date at which the trade was executed (optional, for offchain trades)

**`param`** block at which the Instruction will be executed automatically (optional, the Instruction will be executed when all participants have authorized it if not supplied)

**`note`** required role:

* Venue Owner

### addInstructions

• **addInstructions**: *ProcedureMethod‹*[*AddInstructionsParams*](/polymesh-sdk-api-reference/docs-v5/interfaces/addinstructionsparams.md)*,* [*Instruction*](/polymesh-sdk-api-reference/docs-v5/classes/instruction.md)*\[]›*

*Defined in* [*src/api/entities/Venue/index.ts:210*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Venue/index.ts#L210)

Creates a batch of settlement Instructions in this Venue

**`param`** array of Instructions

**`param`** array of token movements (amount, from, to, token)

**`param`** date at which the trade was agreed upon (optional, for offchain trades)

**`param`** date at which the trade was executed (optional, for offchain trades)

**`param`** block at which the Instruction will be executed automatically (optional, the Instruction will be executed when all participants have authorized it if not supplied)

**`note`** required role:

* Venue Owner

### `Protected` context

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

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule.md)*.*[*context*](/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule.md#protected-context)

*Defined in* [*src/api/entities/Entity.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Entity.ts#L48)

### id

• **id**: *BigNumber*

*Defined in* [*src/api/entities/Venue/index.ts:57*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Venue/index.ts#L57)

Identifier number of the venue

### modify

• **modify**: *ProcedureMethod‹*[*ModifyVenueParams*](/polymesh-sdk-api-reference/docs-v5/globals.md#modifyvenueparams)*, void›*

*Defined in* [*src/api/entities/Venue/index.ts:218*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Venue/index.ts#L218)

Modify description and type

**`note`** required role:

* Venue Owner

### uuid

• **uuid**: *string*

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule.md)*.*[*uuid*](/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule.md#uuid)

*Defined in* [*src/api/entities/Entity.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Entity.ts#L46)

## Methods

### details

▸ **details**(): *Promise‹*[*VenueDetails*](/polymesh-sdk-api-reference/docs-v5/interfaces/venuedetails.md)*›*

*Defined in* [*src/api/entities/Venue/index.ts:110*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Venue/index.ts#L110)

Retrieve information specific to this venue

**Returns:** *Promise‹*[*VenueDetails*](/polymesh-sdk-api-reference/docs-v5/interfaces/venuedetails.md)*›*

### exists

▸ **exists**(): *Promise‹boolean›*

*Defined in* [*src/api/entities/Venue/index.ts:91*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Venue/index.ts#L91)

Retrieve whether the Venue exists

**Returns:** *Promise‹boolean›*

### getPendingInstructions

▸ **getPendingInstructions**(): *Promise‹*[*Instruction*](/polymesh-sdk-api-reference/docs-v5/classes/instruction.md)*\[]›*

*Defined in* [*src/api/entities/Venue/index.ts:144*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Venue/index.ts#L144)

Retrieve all pending Instructions in this Venue

**Returns:** *Promise‹*[*Instruction*](/polymesh-sdk-api-reference/docs-v5/classes/instruction.md)*\[]›*

### isEqual

▸ **isEqual**(`entity`: [Entity](/polymesh-sdk-api-reference/docs-v5/classes/entity.md)‹object›): *boolean*

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule.md)*.*[*isEqual*](/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule.md#isequal)

*Defined in* [*src/api/entities/Entity.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Entity.ts#L61)

Whether this Entity is the same as another one

**Parameters:**

| Name     | Type                                                                    |
| -------- | ----------------------------------------------------------------------- |
| `entity` | [Entity](/polymesh-sdk-api-reference/docs-v5/classes/entity.md)‹object› |

**Returns:** *boolean*

### `Static` generateUuid

▸ **generateUuid**‹**Identifiers**›(`identifiers`: Identifiers): *string*

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule.md)*.*[*generateUuid*](/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule.md#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Entity.ts#L14)

Generate the Entity's UUID from its identifying properties

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

| Name          | Type        | Description |
| ------------- | ----------- | ----------- |
| `identifiers` | Identifiers |             |

**Returns:** *string*

### `Static` unserialize

▸ **unserialize**‹**Identifiers**›(`serialized`: string): *Identifiers*

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule.md)*.*[*unserialize*](/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule.md#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Entity.ts#L23)

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

| Name         | Type   | Description         |
| ------------ | ------ | ------------------- |
| `serialized` | string | UUID to unserialize |

**Returns:** *Identifiers*