# LightningNetworkApi

Defined in: [atomiq-base/src/btc/lightning/LightningNetworkApi.ts:18](https://github.com/atomiqlabs/atomiq-base/blob/df344bedbab9ab3de863e3c2d9246e90bd861d04/src/btc/lightning/LightningNetworkApi.ts#L18)

An interface for Lightning API, provides view of the public lightning network data like channel graph

## Methods

### getLNNodeLiquidity()

```
getLNNodeLiquidity(pubkey): Promise<LNNodeLiquidity>;
```

Defined in: [atomiq-base/src/btc/lightning/LightningNetworkApi.ts:25](https://github.com/atomiqlabs/atomiq-base/blob/df344bedbab9ab3de863e3c2d9246e90bd861d04/src/btc/lightning/LightningNetworkApi.ts#L25)

Returns the lightning network's node liquidity as identified by an identity public key

#### Parameters

| Parameter | Type     | Description |
| --------- | -------- | ----------- |
| `pubkey`  | `string` |             |

#### Returns

`Promise`<`LNNodeLiquidity`>