@@ -1712,7 +1407,7 @@ Optionally, you can also include the following query parameters:
| limit | String (Integer) | (Defaults to 200) Max results per response. Cannot be less than 10. Cannot be greater than 400. |
| ledger | String | Ledger to request paged results from. Use the ledger's hash. |
-*Note:* Pagination using `limit` and `marker` requires a consistent ledger version, so you must also provide the `ledger` query parameter to use pagination.
+*Note:* Pagination using `limit` and `marker` requires a consistent ledger version, so you must also provide the `ledger` query parameter to use pagination. `marker` will be present in the response when there are additional pages to page through.
#### Response ####
@@ -1721,159 +1416,298 @@ The response is an object with a `orders` array, where each member is a [order o
```js
{
"success": true,
- "marker": "DF5DE453A6531A542988861F250376A0C284C2C829DEE0ABC22D663EAFC270F9",
- "limit": 10,
- "ledger": 11082531,
+ "ledger": 11561783,
"validated": true,
- "orders": [{
- "taker_gets": {
- "currency": "EUR",
- "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
- "value": "2500"
+ "orders": [
+ {
+ "type": "buy",
+ "taker_gets": {
+ "currency": "CAD",
+ "counterparty": "rLr7umFScvEZnj3AJzzZjm25yCZYh3tMwc",
+ "value": "11205.2494363431"
+ },
+ "taker_pays": {
+ "currency": "USD",
+ "counterparty": "rDZBotqkN4MywSxm9HDtX4m7V6SRkFo7By",
+ "value": "9933.731769807718"
+ },
+ "sequence": 11,
+ "passive": false
},
- "taker_pays": {
- "currency": "USD",
- "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
- "value": "3750"
+ {
+ "type": "sell",
+ "taker_gets": {
+ "currency": "USD",
+ "counterparty": "rDZBotqkN4MywSxm9HDtX4m7V6SRkFo7By",
+ "value": "9229.29"
+ },
+ "taker_pays": {
+ "currency": "CAD",
+ "counterparty": "rLr7umFScvEZnj3AJzzZjm25yCZYh3tMwc",
+ "value": "10447.55628"
+ },
+ "sequence": 12,
+ "passive": false
},
- "sequence": 105955,
- "passive": false,
- "sell": false
- }, {
- "taker_gets": {
- "currency": "CHF",
- "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
- "value": "47"
+ {
+ "type": "buy",
+ "taker_gets": {
+ "currency": "CAD",
+ "counterparty": "rLr7umFScvEZnj3AJzzZjm25yCZYh3tMwc",
+ "value": "5600"
+ },
+ "taker_pays": {
+ "currency": "USD",
+ "counterparty": "rDZBotqkN4MywSxm9HDtX4m7V6SRkFo7By",
+ "value": "5000"
+ },
+ "sequence": 13,
+ "passive": false
},
+ {
+ "type": "buy",
+ "taker_gets": {
+ "currency": "USD",
+ "counterparty": "rDZBotqkN4MywSxm9HDtX4m7V6SRkFo7By",
+ "value": "4.7"
+ },
+ "taker_pays": {
+ "currency": "XRP",
+ "counterparty": "",
+ "value": "997.876857"
+ },
+ "sequence": 14,
+ "passive": false
+ },
+ {
+ "type": "sell",
+ "taker_gets": {
+ "currency": "XRP",
+ "counterparty": "",
+ "value": "999"
+ },
+ "taker_pays": {
+ "currency": "USD",
+ "counterparty": "rDZBotqkN4MywSxm9HDtX4m7V6SRkFo7By",
+ "value": "4.74525"
+ },
+ "sequence": 15,
+ "passive": false
+ },
+ {
+ "type": "buy",
+ "taker_gets": {
+ "currency": "CAD",
+ "counterparty": "rLr7umFScvEZnj3AJzzZjm25yCZYh3tMwc",
+ "value": "5.35"
+ },
+ "taker_pays": {
+ "currency": "XRP",
+ "counterparty": "",
+ "value": "998.134328"
+ },
+ "sequence": 16,
+ "passive": false
+ },
+ {
+ "type": "sell",
+ "taker_gets": {
+ "currency": "XRP",
+ "counterparty": "",
+ "value": "999"
+ },
+ "taker_pays": {
+ "currency": "CAD",
+ "counterparty": "rLr7umFScvEZnj3AJzzZjm25yCZYh3tMwc",
+ "value": "5.96403"
+ },
+ "sequence": 17,
+ "passive": false
+ },
+ {
+ "type": "buy",
+ "taker_gets": {
+ "currency": "CAD",
+ "counterparty": "rLr7umFScvEZnj3AJzzZjm25yCZYh3tMwc",
+ "value": "1103.64"
+ },
+ "taker_pays": {
+ "currency": "USD",
+ "counterparty": "rDZBotqkN4MywSxm9HDtX4m7V6SRkFo7By",
+ "value": "976.6725663716827"
+ },
+ "sequence": 18,
+ "passive": false
+ },
+ {
+ "type": "sell",
+ "taker_gets": {
+ "currency": "USD",
+ "counterparty": "rDZBotqkN4MywSxm9HDtX4m7V6SRkFo7By",
+ "value": "986.89"
+ },
+ "taker_pays": {
+ "currency": "CAD",
+ "counterparty": "rLr7umFScvEZnj3AJzzZjm25yCZYh3tMwc",
+ "value": "1116.17259"
+ },
+ "sequence": 19,
+ "passive": false
+ },
+ {
+ "type": "sell",
+ "taker_gets": {
+ "currency": "USD",
+ "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
+ "value": "2"
+ },
+ "taker_pays": {
+ "currency": "CAD",
+ "counterparty": "rLr7umFScvEZnj3AJzzZjm25yCZYh3tMwc",
+ "value": "2"
+ },
+ "sequence": 21,
+ "passive": false
+ }
+ ]
+}
+
+```
+
+## Get Order Transaction ##
+[[Source]
](https://github.com/ripple/ripple-rest/blob/59ea02d634ac4a308db2ba21781efbc02f5ccf53/api/orders.js#L505 "Source")
+
+Get the details of an order transaction. An order transaction either [places an order](#place-order) or [cancels an order](#cancel-order).
+
+
+
+*REST*
+
+```
+GET /v1/accounts/{:address}/orders/{:hash}
+```
+
+
+[Try it! >](rest-api-tool.html#get-order-transaction)
+
+The following URL parameters are required by this API endpoint:
+
+| Field | Value | Description |
+|-------|-------|-------------|
+| address | String | The Ripple account address whose orders to look up. |
+| hash | String | The transaction hash for the order |
+
+
+#### Response ####
+
+An example response for an order transaction to place an order:
+
+```js
+{
+ "success": true,
+ "hash": "D53A3B99AC0C3CAF35D72178390ACA94CD42479A98CEA438EEAFF338E5FEB76D",
+ "ledger": 11349675,
+ "validated": true,
+ "timestamp": "2015-01-26T17:49:30.000Z",
+ "fee": "0.012",
+ "action": "order_create",
+ "direction": "outgoing",
+ "order": {
+ "account": "rEQWVz1qN4DWw5J17s3DgXQzUuVYDSpK6M",
"taker_pays": {
"currency": "XRP",
"counterparty": "",
- "value": "4700"
+ "value": "10000000"
},
- "sequence": 106858,
- "passive": false,
- "sell": false
- }, {
"taker_gets": {
+ "currency": "JPY",
+ "counterparty": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN",
+ "value": "0.0001"
+ },
+ "passive": false,
+ "immediate_or_cancel": false,
+ "fill_or_kill": false,
+ "type": "buy",
+ "sequence": 26
+ },
+ "balance_changes": [
+ {
+ "counterparty": "",
+ "currency": "XRP",
+ "value": "-0.012"
+ }
+ ],
+ "order_changes": [
+ {
+ "taker_pays": {
+ "currency": "XRP",
+ "counterparty": "",
+ "value": "10000000"
+ },
+ "taker_gets": {
+ "currency": "JPY",
+ "counterparty": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN",
+ "value": "0.0001"
+ },
+ "sequence": 26,
+ "status": "created"
+ }
+ ]
+}
+
+```
+
+An example response for an order transaction that cancels an order:
+
+```js
+{
+ "success": true,
+ "hash": "3D948699072B40312AE313E7E8297EED83080C9A4D5B564BCACF0951ABF00AC5",
+ "ledger": 11236693,
+ "validated": true,
+ "timestamp": "2015-01-20T21:46:00.000Z",
+ "fee": "0.012",
+ "action": "order_cancel",
+ "direction": "outgoing",
+ "order": {
+ "account": "rEQWVz1qN4DWw5J17s3DgXQzUuVYDSpK6M",
+ "type": "cancel",
+ "sequence": 22,
+ "cancel_sequence": 20
+ },
+ "balance_changes": [{
+ "counterparty": "",
+ "currency": "XRP",
+ "value": "-0.012"
+ }],
+ "order_changes": [{
+ "taker_pays": {
"currency": "XRP",
"counterparty": "",
- "value": "10996.534297"
+ "value": "0"
},
- "taker_pays": {
- "currency": "BTC",
- "counterparty": "rG6FZ31hDHN1K5Dkbma3PSB5uVCuVVRzfn",
- "value": "0.99968493609091"
- },
- "sequence": 105993,
- "passive": false,
- "sell": false
- }, {
"taker_gets": {
- "currency": "BTC",
- "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
- "value": "19.32"
+ "currency": "JPY",
+ "counterparty": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN",
+ "value": "0"
},
- "taker_pays": {
- "currency": "BTC",
- "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
- "value": "21"
- },
- "sequence": 106880,
- "passive": false,
- "sell": false
- }, {
- "taker_gets": {
- "currency": "BTC",
- "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
- "value": "21"
- },
- "taker_pays": {
- "currency": "BTC",
- "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
- "value": "22.47"
- },
- "sequence": 106066,
- "passive": false,
- "sell": false
- }, {
- "taker_gets": {
- "currency": "XRP",
- "counterparty": "",
- "value": "102058.710535"
- },
- "taker_pays": {
- "currency": "MXN",
- "counterparty": "rG6FZ31hDHN1K5Dkbma3PSB5uVCuVVRzfn",
- "value": "44373.35240666822"
- },
- "sequence": 105962,
- "passive": false,
- "sell": false
- }, {
- "taker_gets": {
- "currency": "XRP",
- "counterparty": "",
- "value": "450000"
- },
- "taker_pays": {
- "currency": "USD",
- "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
- "value": "15000"
- },
- "sequence": 105963,
- "passive": false,
- "sell": false
- }, {
- "taker_gets": {
- "currency": "XRP",
- "counterparty": "",
- "value": "17000"
- },
- "taker_pays": {
- "currency": "CAD",
- "counterparty": "r3ADD8kXSUKHd6zTCKfnKT3zV9EZHjzp1S",
- "value": "500"
- },
- "sequence": 105964,
- "passive": false,
- "sell": false
- }, {
- "taker_gets": {
- "currency": "XRP",
- "counterparty": "",
- "value": "28000"
- },
- "taker_pays": {
- "currency": "CAD",
- "counterparty": "r3ADD8kXSUKHd6zTCKfnKT3zV9EZHjzp1S",
- "value": "1000"
- },
- "sequence": 105965,
- "passive": false,
- "sell": false
- }, {
- "taker_gets": {
- "currency": "XRP",
- "counterparty": "",
- "value": "255000"
- },
- "taker_pays": {
- "currency": "USD",
- "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
- "value": "7500"
- },
- "sequence": 105966,
- "passive": false,
- "sell": false
+ "sequence": 20,
+ "status": "canceled"
}]
}
```
+The response includes the original [`order`](#order-objects), if the `action` is `order_create`.
+For transactions that cancel orders, the `order` object describes the transaction that canceled the original order.
+The response also includes `balance_changes` and [`order changes`](order-change-objects)
+for the perspective account (e.g., the Ripple account address used in the URI).
+
+The `direction` of the transaction is either `incoming`, `outgoing` or `unaffected`. Outgoing transactions are made by the perspective account. Incoming transactions affect the perspective account.
## Get Order Book ##
-[[Source]
](https://github.com/ripple/ripple-rest/blob/develop/api/orders.js#L20 "Source")
+[[Source]
](https://github.com/ripple/ripple-rest/blob/59ea02d634ac4a308db2ba21781efbc02f5ccf53/api/orders.js#L38 "Source")
Retrieves the top of the order book for a currency pair.
diff --git a/js/apitool-rest.js b/js/apitool-rest.js
index b3ec113051..d0d50890b9 100644
--- a/js/apitool-rest.js
+++ b/js/apitool-rest.js
@@ -237,7 +237,7 @@ Request("Cancel Order", {
Request("Get Account Orders", {
method: GET,
path: "/v1/accounts/{:address}/orders?{:query_params}",
- description: "Check the status of one or more orders attached to an account.",
+ description: "Get open currency-exchange orders associated with the Ripple address.",
link: "#get-account-orders",
params: {
"{:address}": DEFAULT_ADDRESS_3,
@@ -245,6 +245,17 @@ Request("Get Account Orders", {
}
});
+Request("Get Order Transaction", {
+ method: GET,
+ path: "/v1/accounts/{:address}/orders/{:hash}",
+ description: "Get the details of an order transaction.",
+ link: "#get-order-transaction",
+ params: {
+ "{:address}": "rEQWVz1qN4DWw5J17s3DgXQzUuVYDSpK6M",
+ "{:hash}": "D53A3B99AC0C3CAF35D72178390ACA94CD42479A98CEA438EEAFF338E5FEB76D"
+ }
+});
+
Request("Get Order Book", {
method: GET,
path: "/v1/accounts/{:address}/order_book/{:base}/{:counter}?{:query_params}",
diff --git a/rest-api-tool.html b/rest-api-tool.html
index 9a43944667..ba6e0e57d8 100644
--- a/rest-api-tool.html
+++ b/rest-api-tool.html
@@ -99,6 +99,7 @@
Place Order
Cancel Order
Get Account Orders
+
Get Order Transaction
Get Order Book
Get Trustlines