> For the complete documentation index, see [llms.txt](https://docs.vibetrading.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vibetrading.dev/getting-started/installation.md).

# Installation

## Install

```bash
pip install vibetrading
```

All core dependencies are included: `pandas`, `numpy`, `pydantic`, `ccxt`, `litellm`, `ta`, and `python-dotenv`.

## Setup

Set at least one LLM API key for strategy generation and analysis:

```bash
export OPENAI_API_KEY=sk-...
# or
export ANTHROPIC_API_KEY=sk-ant-...
# or
export GEMINI_API_KEY=...
# or
export DEEPSEEK_API_KEY=...
```

Optional — if you need an HTTPS proxy:

```bash
export HTTPS_PROXY=http://127.0.0.1:7890
```

Or put them in a `.env` file in your project root — the package loads it automatically via `python-dotenv`.

## With Exchange Adapters (optional)

Exchange adapters are available as optional extras for live trading integration:

```bash
pip install "vibetrading[hyperliquid]"   # Hyperliquid L1
pip install "vibetrading[extended]"      # X10 Extended (StarkNet)
pip install "vibetrading[paradex]"       # Paradex (StarkNet)
pip install "vibetrading[lighter]"       # Lighter (zkSync Era)
pip install "vibetrading[aster]"         # Aster Protocol

pip install "vibetrading[all]"           # Everything
```

## Requirements

* Python >= 3.10
* pandas >= 2.0
* numpy >= 1.24
* pydantic >= 2.0
* python-dotenv >= 1.0
* ccxt >= 4.0
* litellm >= 1.80
* ta >= 0.11


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.vibetrading.dev/getting-started/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.