Skip to content

Commit b1d9b11

Browse files
committed
move table up
1 parent c071f03 commit b1d9b11

File tree

1 file changed

+18
-19
lines changed
  • docs/references/http-websocket-apis

1 file changed

+18
-19
lines changed

docs/references/http-websocket-apis/index.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,28 @@ metadata:
88

99
You can communicate with the XRP Ledger through the `rippled` servers' publicly available APIs.
1010

11-
Currently, there are two API versions: `1` and `2` {% badge href="https://github.com/XRPLF/rippled/releases/tag/2.0.0" %}New in: rippled 2.0.0{% /badge %}. The server reports the range of supported API versions in the `version` API method. <!-- STYLE_OVERRIDE: will --> <!-- TODO: add a link when `version` method is documented. -->
11+
Currently, there are two API versions: `1` and `2` {% badge href="https://github.com/XRPLF/rippled/releases/tag/2.0.0" %}New in: rippled 2.0.0{% /badge %}. The server reports the range of supported API versions in the [`version` API method](public-api-methods/server-info-methods/version.md); you can specify which version to use in your API requests.
1212

1313
Separate API requests can use different API versions even on the same persistent connection. For example, if you connect through WebSocket to a server that supports API versions 1 and 2, you can make an `account_tx` request using API version 2 and then make another `account_tx` request using API version 1 from the same connection.
1414

15-
Future versions of `rippled` that introduce breaking changes will introduce a new API version 3.
1615

16+
## Default API Versions
17+
18+
The table below shows which version of the `rippled` API is used if you don't specify it in the request:
19+
20+
| Request Method | API Version | Additional Notes |
21+
|----------------|-------------|------------------|
22+
| Websocket | 1 | |
23+
| JSON-RPC | 1 | |
24+
| Commandline | 2 | The commandline only uses the latest API version. |
25+
| [xrpl.js](https://github.com/XRPLF/xrpl.js) | 2 | Defaults to [API v2][] starting in v4.0.0. |
26+
| [xrpl-py](https://github.com/XRPLF/xrpl-py) | 2 | Defaults to [API v2][] starting in v3.0.0. |
27+
28+
{% admonition type="info" name="Note" %}
29+
Clio responses use [API v1][] by default, but support [API v2][] requests.
30+
{% /admonition %}
31+
32+
Future versions of `rippled` that introduce breaking changes will introduce a new API version 3.
1733

1834
### Breaking Changes
1935

@@ -43,23 +59,6 @@ The following types of changes are **non-breaking changes** and may occur withou
4359
- Adding a new field to a request or response, not including positional parameters.
4460
- Adding a new API method.
4561

46-
47-
## Default API Versions
48-
49-
The table below shows which version of the `rippled` API is used if you don't specify it in the request:
50-
51-
| Request Format | API Version | Additional Notes |
52-
|----------------|-------------|------------------|
53-
| Websocket | 1 | |
54-
| JSON-RPC | 1 | |
55-
| Commandline | 2 | The commandline only uses the latest API version. |
56-
| [xrpl.js](https://github.com/XRPLF/xrpl.js) | 2 | Defaults to [API v2][] starting in v4.0.0. |
57-
| [xrpl-py](https://github.com/XRPLF/xrpl-py) | 2 | Defaults to [API v2][] starting in v3.0.0. |
58-
59-
{% admonition type="info" name="Note" %}
60-
Clio responses use [API v1][] by default, but support [API v2][] requests.
61-
{% /admonition %}
62-
6362
{% raw-partial file="/docs/_snippets/common-links.md" /%}
6463

6564
{% child-pages /%}

0 commit comments

Comments
 (0)