# ExitsApi

All URIs are relative to *http://localhost*

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**exitCancel**](ExitsApi.md#exitcancel) | **POST** /api/v1/exits/cancel/{vtxo_id} | Cancel an exit |
| [**exitClaimAll**](ExitsApi.md#exitclaimalloperation) | **POST** /api/v1/exits/claim/all | Claim all exited VTXOs |
| [**exitClaimVtxos**](ExitsApi.md#exitclaimvtxosoperation) | **POST** /api/v1/exits/claim/vtxos | Claim specific exited VTXOs |
| [**exitProgress**](ExitsApi.md#exitprogressoperation) | **POST** /api/v1/exits/progress | Progress exits |
| [**exitStartAll**](ExitsApi.md#exitstartall) | **POST** /api/v1/exits/start/all | Start exit for all VTXOs |
| [**exitStartVtxos**](ExitsApi.md#exitstartvtxos) | **POST** /api/v1/exits/start/vtxos | Start exit for specific VTXOs |
| [**getAllExitStatus**](ExitsApi.md#getallexitstatus) | **GET** /api/v1/exits/status/all | List all exit statuses |
| [**getAllExitStatusDeprecated**](ExitsApi.md#getallexitstatusdeprecated) | **GET** /api/v1/exits/status | List all exit statuses (deprecated) |
| [**getExitStatusByVtxoId**](ExitsApi.md#getexitstatusbyvtxoid) | **GET** /api/v1/exits/status/vtxo/{vtxo_id} | Get VTXO exit status |
| [**getExitStatusByVtxoIdDeprecated**](ExitsApi.md#getexitstatusbyvtxoiddeprecated) | **GET** /api/v1/exits/status/{vtxo_id} | Get exit status (deprecated) |
| [**getFinishedExits**](ExitsApi.md#getfinishedexits) | **GET** /api/v1/exits/status/finished | List finished exits |
| [**getLiveExitStatus**](ExitsApi.md#getliveexitstatus) | **GET** /api/v1/exits/status/live | List live exit statuses |



## exitCancel

> ExitCancelResponse exitCancel(vtxoId)

Cancel an exit

Aborts an in-progress emergency exit while it is still safe to do so—before its final transaction has been broadcast. Exit transactions are ordered topologically and only the final one moves the VTXO on-chain, so an exit can still be canceled even after its shared ancestor transactions are in the mempool or a block. Canceling leaves the VTXO spendable, so a fresh exit can be started for it later. Before canceling, the endpoint verifies directly against the chain that the final transaction hasn\&#39;t been broadcast; nothing is rebroadcast in the process. Canceling an already-canceled exit succeeds as a no-op, so retries are safe. Note the daemon auto-progresses exits at the cadence defined by &#x60;SLOW_INTERVAL&#x60;, so cancel promptly once an exit reaches a state you no longer wish to pursue.

### Example

```ts
import {
  Configuration,
  ExitsApi,
} from '@secondts/barkd';
import type { ExitCancelRequest } from '@secondts/barkd';

async function example() {
  console.log("🚀 Testing @secondts/barkd SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearer
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new ExitsApi(config);

  const body = {
    // string | The VTXO whose unilateral exit should be canceled
    vtxoId: vtxoId_example,
  } satisfies ExitCancelRequest;

  try {
    const data = await api.exitCancel(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **vtxoId** | `string` | The VTXO whose unilateral exit should be canceled | [Defaults to `undefined`] |

### Return type

[**ExitCancelResponse**](ExitCancelResponse.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Exit canceled successfully |  -  |
| **400** | The VTXO ID is invalid, or the exit can no longer be canceled because its final transaction has already been broadcast |  -  |
| **404** | The VTXO has no exit |  -  |
| **500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## exitClaimAll

> ExitClaimResponse exitClaimAll(exitClaimAllRequest)

Claim all exited VTXOs

Sweeps all claimable exit outputs into a single on-chain transaction sent to the specified address. Unlike &#x60;progress&#x60;, the daemon does not claim automatically—this endpoint must be called manually. Poll the &#x60;status&#x60; endpoint or call &#x60;progress&#x60; and check for &#x60;done: true&#x60; to know when VTXOs are ready to claim. This is the final step of the emergency exit process—the bitcoin is not considered back on-chain until this transaction confirms.

### Example

```ts
import {
  Configuration,
  ExitsApi,
} from '@secondts/barkd';
import type { ExitClaimAllOperationRequest } from '@secondts/barkd';

async function example() {
  console.log("🚀 Testing @secondts/barkd SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearer
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new ExitsApi(config);

  const body = {
    // ExitClaimAllRequest
    exitClaimAllRequest: ...,
  } satisfies ExitClaimAllOperationRequest;

  try {
    const data = await api.exitClaimAll(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **exitClaimAllRequest** | [ExitClaimAllRequest](ExitClaimAllRequest.md) |  | |

### Return type

[**ExitClaimResponse**](ExitClaimResponse.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: `application/json`
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Exit claimed successfully |  -  |
| **400** | The provided destination address is invalid |  -  |
| **500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## exitClaimVtxos

> ExitClaimResponse exitClaimVtxos(exitClaimVtxosRequest)

Claim specific exited VTXOs

Sweeps the specified claimable exit outputs into a single on-chain transaction sent to the specified address. Unlike &#x60;progress&#x60;, the daemon does not claim automatically—this endpoint must be called manually. Poll the &#x60;status&#x60; endpoint or call &#x60;progress&#x60; and check for &#x60;done: true&#x60; to know when VTXOs are ready to claim. This is the final step of the emergency exit process—the bitcoin is not considered back on-chain until this transaction confirms.

### Example

```ts
import {
  Configuration,
  ExitsApi,
} from '@secondts/barkd';
import type { ExitClaimVtxosOperationRequest } from '@secondts/barkd';

async function example() {
  console.log("🚀 Testing @secondts/barkd SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearer
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new ExitsApi(config);

  const body = {
    // ExitClaimVtxosRequest
    exitClaimVtxosRequest: ...,
  } satisfies ExitClaimVtxosOperationRequest;

  try {
    const data = await api.exitClaimVtxos(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **exitClaimVtxosRequest** | [ExitClaimVtxosRequest](ExitClaimVtxosRequest.md) |  | |

### Return type

[**ExitClaimResponse**](ExitClaimResponse.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: `application/json`
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Exit claimed successfully |  -  |
| **400** | One of the provided VTXO isn\&#39;t spendable, or the provided destination address is invalid |  -  |
| **500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## exitProgress

> ExitProgressResponse exitProgress(exitProgressRequest)

Progress exits

Triggers all in-progress exits to advance. The daemon already progresses exits automatically in the background—use this endpoint when you want immediate progress rather than waiting for the next automatic cycle. On each call, the endpoint syncs transaction statuses, advances the exit state machine, and creates or fee-bumps CPFP children for any exit transactions that need them. The on-chain wallet must have sufficient bitcoin to cover transaction fees.

### Example

```ts
import {
  Configuration,
  ExitsApi,
} from '@secondts/barkd';
import type { ExitProgressOperationRequest } from '@secondts/barkd';

async function example() {
  console.log("🚀 Testing @secondts/barkd SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearer
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new ExitsApi(config);

  const body = {
    // ExitProgressRequest
    exitProgressRequest: ...,
  } satisfies ExitProgressOperationRequest;

  try {
    const data = await api.exitProgress(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **exitProgressRequest** | [ExitProgressRequest](ExitProgressRequest.md) |  | |

### Return type

[**ExitProgressResponse**](ExitProgressResponse.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: `application/json`
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns the exit progress |  -  |
| **500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## exitStartAll

> ExitStartResponse exitStartAll()

Start exit for all VTXOs

Registers all wallet VTXOs for emergency exit. The daemon automatically progresses registered exits in the background at the cadence defined by &#x60;SLOW_INTERVAL&#x60;, creating and broadcasting the required transactions in sequence. Once all exit transactions are confirmed and the timelock has elapsed, call &#x60;claim&#x60; to sweep the resulting outputs to an on-chain address.

### Example

```ts
import {
  Configuration,
  ExitsApi,
} from '@secondts/barkd';
import type { ExitStartAllRequest } from '@secondts/barkd';

async function example() {
  console.log("🚀 Testing @secondts/barkd SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearer
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new ExitsApi(config);

  try {
    const data = await api.exitStartAll();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters

This endpoint does not need any parameter.

### Return type

[**ExitStartResponse**](ExitStartResponse.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Exit started successfully |  -  |
| **500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## exitStartVtxos

> ExitStartResponse exitStartVtxos(exitStartRequest)

Start exit for specific VTXOs

Registers the specified VTXOs for emergency exit. The daemon automatically progresses registered exits in the background at the cadence defined by &#x60;SLOW_INTERVAL&#x60;, creating and broadcasting the required transactions in sequence. Once all exit transactions are confirmed and the timelock has elapsed, call &#x60;claim&#x60; to sweep the resulting outputs to an on-chain address.

### Example

```ts
import {
  Configuration,
  ExitsApi,
} from '@secondts/barkd';
import type { ExitStartVtxosRequest } from '@secondts/barkd';

async function example() {
  console.log("🚀 Testing @secondts/barkd SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearer
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new ExitsApi(config);

  const body = {
    // ExitStartRequest
    exitStartRequest: ...,
  } satisfies ExitStartVtxosRequest;

  try {
    const data = await api.exitStartVtxos(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **exitStartRequest** | [ExitStartRequest](ExitStartRequest.md) |  | |

### Return type

[**ExitStartResponse**](ExitStartResponse.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: `application/json`
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Exit started successfully |  -  |
| **400** | No VTXO IDs provided, or one of the provided VTXO IDs is invalid |  -  |
| **404** | One the VTXOs wasn\&#39;t found |  -  |
| **500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## getAllExitStatus

> Array&lt;ExitTransactionStatus&gt; getAllExitStatus(history, transactions)

List all exit statuses

Returns every exit, live and finished. Optionally includes each exit\&#39;s state history and its transactions with their CPFP children.

### Example

```ts
import {
  Configuration,
  ExitsApi,
} from '@secondts/barkd';
import type { GetAllExitStatusRequest } from '@secondts/barkd';

async function example() {
  console.log("🚀 Testing @secondts/barkd SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearer
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new ExitsApi(config);

  const body = {
    // boolean | Whether to include the detailed history of the exit process (optional)
    history: true,
    // boolean | Whether to include the exit transactions and their CPFP children (optional)
    transactions: true,
  } satisfies GetAllExitStatusRequest;

  try {
    const data = await api.getAllExitStatus(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **history** | `boolean` | Whether to include the detailed history of the exit process | [Optional] [Defaults to `undefined`] |
| **transactions** | `boolean` | Whether to include the exit transactions and their CPFP children | [Optional] [Defaults to `undefined`] |

### Return type

[**Array&lt;ExitTransactionStatus&gt;**](ExitTransactionStatus.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns all exit statuses |  -  |
| **500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## getAllExitStatusDeprecated

> getAllExitStatusDeprecated()

List all exit statuses (deprecated)

Deprecated: redirects to &#x60;GET /exits/status/all&#x60;.

### Example

```ts
import {
  Configuration,
  ExitsApi,
} from '@secondts/barkd';
import type { GetAllExitStatusDeprecatedRequest } from '@secondts/barkd';

async function example() {
  console.log("🚀 Testing @secondts/barkd SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearer
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new ExitsApi(config);

  try {
    const data = await api.getAllExitStatusDeprecated();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters

This endpoint does not need any parameter.

### Return type

`void` (Empty response body)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **308** | Permanent redirect to &#x60;/exits/status/all&#x60; |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## getExitStatusByVtxoId

> ExitTransactionStatus getExitStatusByVtxoId(vtxoId, history, transactions)

Get VTXO exit status

Returns the exit status for the given VTXO, live or finished. Optionally includes the state history and the exit transactions with their CPFP children.

### Example

```ts
import {
  Configuration,
  ExitsApi,
} from '@secondts/barkd';
import type { GetExitStatusByVtxoIdRequest } from '@secondts/barkd';

async function example() {
  console.log("🚀 Testing @secondts/barkd SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearer
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new ExitsApi(config);

  const body = {
    // string | The VTXO to check the exit status of
    vtxoId: vtxoId_example,
    // boolean | Whether to include the detailed history of the exit process (optional)
    history: true,
    // boolean | Whether to include the exit transactions and their CPFP children (optional)
    transactions: true,
  } satisfies GetExitStatusByVtxoIdRequest;

  try {
    const data = await api.getExitStatusByVtxoId(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **vtxoId** | `string` | The VTXO to check the exit status of | [Defaults to `undefined`] |
| **history** | `boolean` | Whether to include the detailed history of the exit process | [Optional] [Defaults to `undefined`] |
| **transactions** | `boolean` | Whether to include the exit transactions and their CPFP children | [Optional] [Defaults to `undefined`] |

### Return type

[**ExitTransactionStatus**](ExitTransactionStatus.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns the exit status |  -  |
| **404** | VTXO wasn\&#39;t found |  -  |
| **500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## getExitStatusByVtxoIdDeprecated

> ExitTransactionStatus getExitStatusByVtxoIdDeprecated(vtxoId, history, transactions)

Get exit status (deprecated)

Deprecated: use &#x60;GET /exits/status/vtxo/{vtxo_id}&#x60; instead.

### Example

```ts
import {
  Configuration,
  ExitsApi,
} from '@secondts/barkd';
import type { GetExitStatusByVtxoIdDeprecatedRequest } from '@secondts/barkd';

async function example() {
  console.log("🚀 Testing @secondts/barkd SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearer
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new ExitsApi(config);

  const body = {
    // string | The VTXO to check the exit status of
    vtxoId: vtxoId_example,
    // boolean | Whether to include the detailed history of the exit process (optional)
    history: true,
    // boolean | Whether to include the exit transactions and their CPFP children (optional)
    transactions: true,
  } satisfies GetExitStatusByVtxoIdDeprecatedRequest;

  try {
    const data = await api.getExitStatusByVtxoIdDeprecated(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **vtxoId** | `string` | The VTXO to check the exit status of | [Defaults to `undefined`] |
| **history** | `boolean` | Whether to include the detailed history of the exit process | [Optional] [Defaults to `undefined`] |
| **transactions** | `boolean` | Whether to include the exit transactions and their CPFP children | [Optional] [Defaults to `undefined`] |

### Return type

[**ExitTransactionStatus**](ExitTransactionStatus.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns the exit status |  -  |
| **404** | VTXO wasn\&#39;t found |  -  |
| **500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## getFinishedExits

> Array&lt;ExitTransactionStatus&gt; getFinishedExits(history, transactions)

List finished exits

Returns exits that reached a terminal state: claimed, aborted because the VTXO was already spent, or canceled. Finished exits are dropped from active tracking—they are never progressed—but they\&#39;re retained for auditing and surfaced here.

### Example

```ts
import {
  Configuration,
  ExitsApi,
} from '@secondts/barkd';
import type { GetFinishedExitsRequest } from '@secondts/barkd';

async function example() {
  console.log("🚀 Testing @secondts/barkd SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearer
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new ExitsApi(config);

  const body = {
    // boolean | Whether to include the detailed state history of each finished exit (optional)
    history: true,
    // boolean | Whether to include the exit transactions and their CPFP children (optional)
    transactions: true,
  } satisfies GetFinishedExitsRequest;

  try {
    const data = await api.getFinishedExits(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **history** | `boolean` | Whether to include the detailed state history of each finished exit | [Optional] [Defaults to `undefined`] |
| **transactions** | `boolean` | Whether to include the exit transactions and their CPFP children | [Optional] [Defaults to `undefined`] |

### Return type

[**Array&lt;ExitTransactionStatus&gt;**](ExitTransactionStatus.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns the finished exits |  -  |
| **500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## getLiveExitStatus

> Array&lt;ExitTransactionStatus&gt; getLiveExitStatus(history, transactions)

List live exit statuses

Returns exits that are still progressing. Optionally includes each exit\&#39;s state history and its transactions with their CPFP children.

### Example

```ts
import {
  Configuration,
  ExitsApi,
} from '@secondts/barkd';
import type { GetLiveExitStatusRequest } from '@secondts/barkd';

async function example() {
  console.log("🚀 Testing @secondts/barkd SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: bearer
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new ExitsApi(config);

  const body = {
    // boolean | Whether to include the detailed history of the exit process (optional)
    history: true,
    // boolean | Whether to include the exit transactions and their CPFP children (optional)
    transactions: true,
  } satisfies GetLiveExitStatusRequest;

  try {
    const data = await api.getLiveExitStatus(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **history** | `boolean` | Whether to include the detailed history of the exit process | [Optional] [Defaults to `undefined`] |
| **transactions** | `boolean` | Whether to include the exit transactions and their CPFP children | [Optional] [Defaults to `undefined`] |

### Return type

[**Array&lt;ExitTransactionStatus&gt;**](ExitTransactionStatus.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns the live exit statuses |  -  |
| **500** | Internal server error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

