+
*REST*
```
@@ -753,6 +760,7 @@ POST /v1/accounts/{:address}/settings?validated=true
}
}
```
+
[Try it! >](rest-api-tool.html#update-account-settings)
@@ -833,11 +841,13 @@ The response is a JSON object containing the following fields:
Get quotes for possible ways to make a particular payment.
+
*REST*
```
GET /v1/accounts/{:source_address}/payments/paths/{:destination_address}/{:amount}
```
+
[Try it! >](rest-api-tool.html#prepare-payment)
@@ -924,6 +934,7 @@ __NOTE:__ This command may be quite slow. If the command times out, please try i
Submit a payment object to be processed and executed.
+
*REST*
```
@@ -1021,11 +1032,13 @@ The response can take two formats, depending on the `validated` query parameter:
Retrieve the details of a payment, including the current state of the transaction and the result of transaction processing.
+
*REST*
```
GET /v1/accounts/{:address}/payments/{:id}
```
+
[Try it! >](rest-api-tool.html#confirm-payment)
@@ -1093,7 +1106,7 @@ The following URL parameters are required by this API endpoint:
If the `payment.state` field has the value `"validated"`, then the payment has been finalized, and is included in the shared global ledger. However, this does not necessarily mean that it succeeded. Check the `payment.result` field for a value of `"tesSUCCESS"` to see if the payment was successfully executed. If the `payment.partial_payment` flag is *true*, then you should also consult the `payment.destination_balance_changes` array to see how much currency was actually delivered to the destination account.
-Processing a payment can take several seconds to complete, depending on the [consensus process](consensus-whitepaper.html). If the payment does not exist yet, or has not been validated, you should wait a few seconds before checking again.
+Processing a payment can take several seconds to complete, depending on the [consensus process](https://ripple.com/consensus-whitepaper/). If the payment does not exist yet, or has not been validated, you should wait a few seconds before checking again.
@@ -1103,11 +1116,13 @@ Processing a payment can take several seconds to complete, depending on the [con
Retrieve a selection of payments that affected the specified account.
+
*REST*
```
GET /v1/accounts/{:address}/payments
```
+
[Try it! >](rest-api-tool.html#get-payment-history)
@@ -1583,11 +1598,13 @@ Get the details of an order transaction. An order transaction either [places an
+
*REST*
```
GET /v1/accounts/{:address}/orders/{:hash}
```
+
[Try it! >](rest-api-tool.html#get-order-transaction)
@@ -1714,11 +1731,13 @@ The `direction` of the transaction is either `incoming`, `outgoing` or `unaffect
Retrieves the top of the order book for a currency pair.
+
*REST*
```
GET /v1/accounts/{:address}/order_book/{:base}/{:counter}
```
+
[Try it! >](rest-api-tool.html#get-order-book)
@@ -1885,11 +1904,13 @@ The response includes `bids` and `asks` arrays that contain [bid objects](#bid-o
Retrieves all trustlines associated with the Ripple address.
+
*REST*
```
GET /v1/accounts/{:address}/trustlines
```
+
[Try it! >](rest-api-tool.html#get-trustlines)
@@ -1954,6 +1975,7 @@ The response is an object with a `lines` array, where each member is a [trustlin
Creates or modifies a trustline.
+
*REST*
```
@@ -1968,6 +1990,7 @@ POST /v1/accounts/{:address}/trustlines?validated=true
}
}
```
+
[Try it! >](rest-api-tool.html#grant-trustline)
@@ -2026,11 +2049,13 @@ Notifications are sorted in order of when they occurred, so you can save the mos
Get a notification for the specific transaction hash, along with links to previous and next notifications, if available.
+
*REST*
```
GET /v1/accounts/{:address}/notifications/{:id}
```
+
[Try it! >](rest-api-tool.html#check-notifications)
@@ -2092,11 +2117,13 @@ The following two endpoints can be used to check if the `ripple-rest` API is cur
Perform a simple ping to make sure that the server is working properly.
+
*REST*
```
GET /v1/server/connected
```
+
[Try it! >](rest-api-tool.html#check-connection)
@@ -2118,11 +2145,13 @@ If the server has any problems, for example with connecting to the `rippled` ser
Retrieve information about the current status of the Ripple-REST API and the `rippled` server it is connected to.
+
*REST*
```
GET /v1/server
```
+
[Try it! >](rest-api-tool.html#get-server-status)
@@ -2205,11 +2234,13 @@ The `rippled_server_status` object may have any of the following fields:
Returns a Ripple transaction, in its complete, original format.
+
*REST*
```
GET /v1/transactions/{:id}
```
+
[Try it! >](rest-api-tool.html#retrieve-ripple-transaction)
@@ -2410,11 +2441,13 @@ The result is a JSON object, whose `transaction` field has the requested transac
Retrieve the current transaction fee, in XRP, for the `rippled` server Ripple-REST is connected to. If Ripple-REST is connected to multiple rippled servers, returns the median fee among the connected servers.
+
*REST*
```
GET /v1/transaction-fee
```
+
[Try it! >](rest-api-tool.html#retrieve-transaction-fee)
@@ -2436,11 +2469,13 @@ The response is a JSON object, whose `fee` field is a string containing a decima
Generate a universally-unique identifier suitable for use as the Client Resource ID for a payment.
+
*REST*
```
GET /v1/uuid
```
+
[Try it! >](rest-api-tool.html#generate-uuid)
diff --git a/tool/githubify.py b/tool/githubify.py
new file mode 100755
index 0000000000..d3ee7c5e98
--- /dev/null
+++ b/tool/githubify.py
@@ -0,0 +1,48 @@
+#!/bin/env python3
+"""
+Convert between Dev-Portal-ready markdown and Github-ready markdown. Has two modes:
+Normal - Convert from Dev Portal format to Github:
+ * Comments out divs that the dev portal uses to generate tabs, so that Github parses the markdown inside
+ * Replaces local relative links with absolute links to ripple.com
+Reverse - Convert from Github format to Dev Portal:
+ * Uncomments multicode divs
+ * Replaces absolute links with local ones that will work even offline.
+
+Usage: githubify.py ripplerest_api.md > readme.md
+
+You may still want to do some manual editing (for example, to add Travis status icons to your readme)
+"""
+
+import sys
+
+def convert_page(text, reverse):
+ replacements = {
+ "
": "",
+ "
": "",
+ "(rest-api-tool.html": "(https://ripple.com/build/rest-tool",
+ "(transactions.html": "(https://ripple.com/build/transactions",
+ "(rippled-apis.html": "(https://ripple.com/build/rippled-apis",
+ }
+
+ for (k,v) in replacements.items():
+ if reverse:
+ text = text.replace(v,k)
+ else:
+ text = text.replace(k,v)
+
+ return text
+
+if __name__ == "__main__":
+ if len(sys.argv) < 2 or len(sys.argv) > 3:
+ exit("usage: %s infile [reverse]" % sys.argv[0])
+
+ if len(sys.argv) == 3 and sys.argv[2].lower() == "reverse":
+ reverse = True
+ else:
+ reverse = False
+
+ with open(sys.argv[1]) as f:
+ text = f.read()
+ text = convert_page(text, reverse)
+ print(text)
+