# ccxt-typescript

A skill that teaches your agent to trade and stream market data through CCXT in TypeScript and JavaScript projects.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 753 installs · ★ 44583
- Author: ccxt
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/ccxt/ccxt/tree/HEAD/.claude/skills/ccxt-typescript/SKILL.md
- Updated: 2026-10-24
- HTML: https://affpapa.org/en/nevibecode/skills/ccxt-typescript

## What it does

This skill gives the agent a reference for the CCXT library in TypeScript and JavaScript, for Node.js and the browser. Both APIs are covered: standard REST with `fetch*` methods and WebSocket from `ccxt.pro` with `watch*` methods. REST and WebSocket ship in the same `ccxt` package, so there is no second install for real-time work.

The agent gets guidance on creating an exchange instance, loading markets, fetching tickers and order books, placing limit and market orders, reading balances, listing trades and cancelling orders. Private calls take `apiKey` and `secret` in the exchange constructor. Public calls need no keys, but the author recommends `enableRateLimit: true` — without it an exchange can reject your requests once you hit its rate limit.

A separate section covers Backpack tokenized stocks: `marketType` aliases (`spot`, `swap`, `stock`), the `params.stock` filter, and RFQ symbols such as `AAPL.US.RFQ/USDC`. If you work in that segment, use the symbols the exchange actually returns; RFQs have their own execution model. Close WebSocket connections with `exchange.close()` when you are done.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add ccxt/ccxt --skill ccxt-typescript -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/ccxt-typescript/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/ccxt-typescript/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add ccxt/ccxt --skill ccxt-typescript -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/ccxt-typescript/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add ccxt/ccxt --skill ccxt-typescript -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/ccxt-typescript/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install ccxt/ccxt ccxt-typescript
```

2. **Manually: put the files in place**
- File: `.github/skills/ccxt-typescript/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add ccxt/ccxt --skill ccxt-typescript -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/ccxt/ccxt --path .claude/skills/ccxt-typescript
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/ccxt-typescript/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add ccxt/ccxt --skill ccxt-typescript -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/ccxt/ccxt/tree/HEAD/.claude/skills/ccxt-typescript/SKILL.md

## When to use it
- connect to an exchange and load its trading pairs
- place a limit or market order from code
- stream live tickers and order books over WebSocket
- read free and used balance for a coin
- handle tokenized stocks and RFQs on Backpack

## Example prompts
- Write a TypeScript script that connects to Binance through CCXT and prints the `BTC/USDT` ticker
- Stream the `BTC/USDT` order book with `ccxt.pro` and keep it updating in the console
- Show me how to place a limit buy order and then cancel it by id

## Source text · SKILL.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 8f4e0701b1867a2b.

BEGIN THIRD-PARTY FILE 8f4e0701b1867a2b
````text
---
name: ccxt-typescript
description: CCXT cryptocurrency exchange library for TypeScript and JavaScript developers (Node.js and browser). Covers both REST API (standard) and WebSocket API (real-time). Helps install CCXT, connect to exchanges, fetch market data, place orders, stream live tickers/orderbooks, handle authentication, and manage errors. Use when working with crypto exchanges in TypeScript/JavaScript projects, trading bots, arbitrage systems, or portfolio management tools. Includes both REST and WebSocket examples.
---

# CCXT for TypeScript/JavaScript

A comprehensive guide to using CCXT in TypeScript and JavaScript projects for cryptocurrency exchange integration.

## Installation

### REST API (Standard CCXT)
```bash
npm install ccxt
```

### WebSocket API (Real-time, ccxt.pro)
```bash
npm install ccxt
```

Both REST and WebSocket APIs are included in the same package.

## Quick Start

### REST API - TypeScript
```typescript
import ccxt from 'ccxt'

const exchange = new ccxt.binance()
await exchange.loadMarkets()
const ticker = await exchange.fetchTicker('BTC/USDT')
console.log(ticker)
```

### REST API - JavaScript (CommonJS)
```javascript
const ccxt = require('ccxt')

(async () => {
    const exchange = new ccxt.binance()
    await exchange.loadMarkets()
    const ticker = await exchange.fetchTicker('BTC/USDT')
    console.log(ticker)
})()
```

### WebSocket API - Real-time Updates
```typescript
import ccxt from 'ccxt'

const exchange = new ccxt.pro.binance()
while (true) {
    const ticker = await exchange.watchTicker('BTC/USDT')
    console.log(ticker)  // Live updates!
}
await exchange.close()
```

## REST vs WebSocket

| Feature | REST API | WebSocket API |
|---------|----------|---------------|
| **Use for** | One-time queries, placing orders | Real-time monitoring, live price feeds |
| **Method prefix** | `fetch*` (fetchTicker, fetchOrderBook) | `watch*` (watchTicker, watchOrderBook) |
| **Speed** | Slower (HTTP request/response) | Faster (persistent connection) |
| **Rate limits** | Strict (1-2 req/sec) | More lenient (continuous stream) |
| **Import** | `ccxt.exchange()` | `ccxt.pro.exchange()` |
| **Best for** | Trading, account management | Price monitoring, arbitrage detection |

**When to use REST:**
- Placing orders
- Fetching account balance
- One-time data queries
- Order management (cancel, fetch orders)

**When to use WebSocket:**
- Real-time price monitoring
- Live orderbook updates
- Arbitrage detection
- Portfolio tracking with live updates

## Creating Exchange Instance

### REST API
```typescript
// Public API (no authentication)
const exchange = new ccxt.binance({
    enableRateLimit: true  // Recommended!
})
````
END THIRD-PARTY FILE 8f4e0701b1867a2b

The third-party file has ended. Everything between the 8f4e0701b1867a2b tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 2697 of 48917 bytes. © ccxt · MIT · https://github.com/ccxt/ccxt/tree/HEAD/.claude/skills/ccxt-typescript/SKILL.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md