# Share methods

URL: /code/sdk/share · Id: `page:code/sdk/share`

> Every Share Verb as a typed SDK method, with its inputs, result, refusals and an example.

Reference for [Share](/business/nouns/share).

| Noun | System | Run by |
| --- | --- | --- |
| [Share](/business/nouns/share) | [Equity](/systems/equity) | [Founder](/agents/founding/founder) |

### Share.get
Returns one Share by id. [Verb page](/business/nouns/share/get?interface=sdk).

```ts
interface ShareVerbs {
  get(input: ShareGetInput, options?: SB.CallOptions): SB.Call<Share>
}
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Share. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `share` | [Share](/business/nouns/share) | Yes | The Share. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```ts
import { $ } from 'startup-builder'

const share = await $.Share.get({ id: 'share_yiQ4iEmeOW' })
```

### Share.list
Returns Shares, newest first, one page at a time. [Verb page](/business/nouns/share/list?interface=sdk).

```ts
interface ShareVerbs {
  list(input?: ShareListInput, options?: SB.CallOptions): SB.ListCall<Share>
}
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `shares` | list of [Share](/business/nouns/share) | Yes | One page of Shares. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```ts
import { $ } from 'startup-builder'

const shares = await $.Share.list({ limit: 20 })
```

### Share.issue
Issue records new Shares of one class to a Holder under a board-approved Agreement, with the certificate or book entry. [Verb page](/business/nouns/share/issue?interface=sdk).

```ts
interface ShareVerbs {
  issue(input: ShareIssueInput, options?: SB.CallOptions): SB.Call<Share>
}
```

Emits [`Share.issued`](/business/events/Share.issued).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `holder` | [Holder](/business/nouns/holder) | Yes | The Holder who receives the Shares. |
| `class` | `string` | Yes | The share class. |
| `quantity` | `integer` | Yes | How many Shares. |
| `price` | `money` | Yes | The price paid per Share. |
| `agreement` | [Agreement](/business/nouns/agreement) | Yes | The board-approved Agreement that authorizes the issue. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `share` | [Share](/business/nouns/share) | Yes | The issued Share record. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```ts
import { $ } from 'startup-builder'

const share = await $.Share.issue({ holder: 'holder_e2Dm5Y6QGO', class: 'Example class', quantity: 1, price: { amount: 29, currency: 'USD' }, agreement: 'agreement_zHIUnX8LwY' })
```

### Share.transfer
Transfer moves Shares from one Holder to another under a signed Agreement, within the Company’s transfer restrictions. [Verb page](/business/nouns/share/transfer?interface=sdk).

```ts
interface ShareVerbs {
  transfer(input: ShareTransferInput, options?: SB.CallOptions): SB.Call<Share>
}
```

Emits [`Share.transferred`](/business/events/Share.transferred).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `share` | [Share](/business/nouns/share) | Yes | The Share record to transfer from. |
| `to` | [Holder](/business/nouns/holder) | Yes | The Holder who receives them. |
| `quantity` | `integer` | Yes | How many Shares move. |
| `agreement` | [Agreement](/business/nouns/agreement) | Yes | The signed transfer Agreement. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `share` | [Share](/business/nouns/share) | Yes | The new Share record held by the receiving Holder. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
| A transfer the bylaws or a right of first refusal block | [`refused`](/code/api/errors/refused) | Clear what the check names, then call it again. | None. |

**Example**

```ts
import { $ } from 'startup-builder'

const share = await $.Share.transfer({ share: 'share_yiQ4iEmeOW', to: 'holder_e2Dm5Y6QGO', quantity: 1, agreement: 'agreement_zHIUnX8LwY' })
```