rostrum 14.0.1

An efficient implementation of Electrum Server with token support
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

# HTTP/HTTPS Connection

Rostrum supports both HTTP and HTTPS connections. Enable HTTP with the `--http` switch, or HTTPS with the `--https` switch. HTTPS requires SSL certificate files to be provided. See [configuration document](configuration.md) for details on enabling these switches. See also [default ports](ports.md) for connection information.

## HTTP vs HTTPS

- **HTTP**: Plain text connections (use `--http`)
- **HTTPS**: Encrypted connections using SSL/TLS (use `--https`)

For production use, **HTTPS is strongly recommended** as it provides encryption and security for your API calls.

Requests are submitted as `POST` request, with the same request format as with other protocols as the body content.

## wget examples

### HTTP
```bash
wget --post-data='{"method": "server.ping", "params": []}' -q http://localhost:31400 -O -
{"id":0,"jsonrpc":"2.0","result":null}
```

### HTTPS
```bash
wget --post-data='{"method": "server.ping", "params": []}' -q --no-check-certificate https://localhost:61401 -O -
{"id":0,"jsonrpc":"2.0","result":null}
```


## Python examples

### HTTP
```python
import http.client
import json

conn = http.client.HTTPConnection("localhost", 31400)
data = {"method": "server.ping", "params": []}
conn.request("POST", "/", body=json.dumps(data))

response = conn.getresponse()
print(json.loads(response.read().decode()))
```

### HTTPS
```python
import http.client
import json
import ssl

# Create SSL context (for self-signed certificates)
ssl_context = ssl.create_default_context()
ssl_context.check_hostname = False
ssl_context.verify_mode = ssl.CERT_NONE

conn = http.client.HTTPSConnection("localhost", 61401, context=ssl_context)
data = {"method": "server.ping", "params": []}
conn.request("POST", "/", body=json.dumps(data))

response = conn.getresponse()
print(json.loads(response.read().decode()))
```

# Node.js examples

### HTTP
```javascript
const http = require('http');

const data = JSON.stringify({ method: "server.ping", params: [] });

const options = {
  hostname: 'localhost',
  port: 31400,
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
};

http.request(options, (res) => {
  res.setEncoding('utf8');
  res.on('data', console.log);
}).on('error', console.error)
  .end(data);
```

### HTTPS
```javascript
const https = require('https');

const data = JSON.stringify({ method: "server.ping", params: [] });

const options = {
  hostname: 'localhost',
  port: 61401,
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  // For self-signed certificates
  rejectUnauthorized: false
};

https.request(options, (res) => {
  res.setEncoding('utf8');
  res.on('data', console.log);
}).on('error', console.error)
  .end(data);
```