> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shadowfeed.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install the ShadowFeed Agent SDK

# Installation

## npm

```bash theme={null}
npm install shadowfeed-agent
```

## yarn

```bash theme={null}
yarn add shadowfeed-agent
```

## pnpm

```bash theme={null}
pnpm add shadowfeed-agent
```

## Requirements

* **Node.js** 18 or later
* **TypeScript** 5.0+ (optional but recommended)

## Dependencies

The SDK automatically installs these dependencies:

| Package       | Purpose                                     |
| ------------- | ------------------------------------------- |
| `axios`       | HTTP client for API requests                |
| `x402-stacks` | x402 payment protocol for Stacks blockchain |

## Verify Installation

```typescript theme={null}
import { ShadowFeed } from 'shadowfeed-agent';

const sf = new ShadowFeed({
  privateKey: 'your-private-key-hex',
  network: 'mainnet',
});

// Should log your SP... address
console.log(sf.address);
```

## TypeScript Support

The SDK ships with full TypeScript declarations. All types are exported:

```typescript theme={null}
import type {
  ShadowFeedConfig,
  FeedId,
  FeedInfo,
  PurchaseResult,
  ChainResult,
  DiscoverOptions,
} from 'shadowfeed-agent';
```