lnm-sdk 0.6.0

Rust SDK for interacting with LN Markets.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

# Examples

Example applications demonstrating different ways to use the `lnm-sdk` crate.

## Quick Templates

Direct source code links for quick reference:

| Category | Raw Source |
|----------|------------|
| **REST API v3 - Public Endpoints** | [rest_v3_public.rs](https://raw.githubusercontent.com/flemosr/lnm-sdk/refs/heads/main/examples/rest_v3_public.rs) |
| **REST API v3 - Authenticated Endpoints** | [rest_v3_auth.rs](https://raw.githubusercontent.com/flemosr/lnm-sdk/refs/heads/main/examples/rest_v3_auth.rs) |
| **Stream API v1 - Public Subscriptions** | [stream_v1_public.rs](https://raw.githubusercontent.com/flemosr/lnm-sdk/refs/heads/main/examples/stream_v1_public.rs) |
| **Stream API v1 - Authenticated Subscriptions** | [stream_v1_auth.rs](https://raw.githubusercontent.com/flemosr/lnm-sdk/refs/heads/main/examples/stream_v1_auth.rs) |

## Prerequisites

REST examples use `https://api.lnmarkets.com/v3` via `RestClientConfig::default()`.

Stream examples use `wss://stream.lnmarkets.com/v1` via `StreamClientConfig::default()`.

Authenticated examples (`rest_v3_auth` and `stream_v1_auth`) require LN Markets API credentials:
- `LNM_API_KEY` - Your API key
- `LNM_API_SECRET` - Your API secret
- `LNM_API_PASSPHRASE` - Your API passphrase

These environment variables should be set, or a `.env` file should be added in the project root.
A [`.env.template`](https://github.com/flemosr/lnm-sdk/blob/main/.env.template) file is available.

## REST API v3

The following examples demonstrate the current REST API v3 interface.

### rest_v3_public

Demonstrates how to use the REST API v3 public client to fetch market data, including utilities
endpoints, futures data, and oracle data.

**Usage:**
```bash
cargo run --example rest_v3_public
```

### rest_v3_auth

Demonstrates how to use the REST API v3 authenticated client to manage both isolated and
cross-margin futures positions, including placing orders, managing margin, and closing positions.

**Usage:**
```bash
cargo run --example rest_v3_auth
```

## Stream API v1

The following examples demonstrate the current Stream API v1 WebSocket interface.

### stream_v1_public

Demonstrates how to connect to Stream v1 and subscribe to public market-data topics.

**Usage:**
```bash
cargo run --example stream_v1_public
```

### stream_v1_auth

Demonstrates how to authenticate a Stream v1 session with REST v3 API credentials and subscribe to
private account topics.

**Usage:**
```bash
cargo run --example stream_v1_auth
```