ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-27 23:25:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOC] REST - fix order documentation

Browse Source
This commit is contained in:
mDuo13
2015-01-13 17:03:14 -08:00
parent a3b466c1c5
commit 87c2fc9251
1 changed files with 32 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
content/ripplerest_api.md
View File

@@ -1469,9 +1469,12 @@ If the length of the `payments` array is equal to `results_per_page`, then there
## Place Order ##
[[Source]<br>](https://github.com/ripple/ripple-rest/blob/develop/api/orders.js#L110 "Source")
Places an order on the ripple network.
(New in [Ripple-REST v1.3.2](https://github.com/ripple/ripple-rest/releases/tag/1.3.2-rc2))
Places an order to exchange currencies.
<div class='multicode'>
*REST*
```
@@ -1493,10 +1496,17 @@ POST /v1/accounts/{:address}/orders?validated=true
}
}
```
</div>
[Try it! >](rest-api-tool.html#place-order)
The following URL parameters are required by this API endpoint:
| Field | Type | Description |
|-------|------|-------------|
| address | String | The Ripple account address the account creating the order. |
The following parameters are required in the JSON body of the request:
| Field | Value | Description |
@@ -1540,26 +1550,41 @@ __DO NOT SUBMIT YOUR SECRET TO AN UNTRUSTED REST API SERVER__ -- The secret key
```
## Cancel Order ##
[[Source]<br>](https://github.com/ripple/ripple-rest/blob/develop/api/orders.js#L243 "Source")
(New in [Ripple-REST v1.3.2](https://github.com/ripple/ripple-rest/releases/tag/1.3.2-rc2))
Deletes a previous order to exchange currencies.
<div class='multicode'>
*REST*
```
DELETE /v1/accounts/{:address}/orders?validated=true
DELETE /v1/accounts/{:address}/orders/{:order}?validated=true
{
"secret": "sneThnzgBgxc3zXPG...."
}
```
</div>
[Try it! >](rest-api-tool.html#cancel-order)
The following URL parameters are required by this API endpoint:
| Field | Type | Description |
|-------|------|-------------|
| address | String | The Ripple account address of an account involved in the transaction. |
| order | Integer | The `sequence` number of the order to cancel. |
The following parameters are required in the JSON body of the request:
| Field | Value | Description |
|-------|-------|-------------|
| secret | String | A secret key for your Ripple account. This is either the master secret, or a regular secret, if your account has one configured. |
*Note:* Some older client libraries do not support a body for the DELETE method. If this is a problem for you, please [file an issue in Ripple Labs' bug tracker](https://ripplelabs.atlassian.net/browse/RLJS).
Optionally, you can include the following as a URL query parameter:
| Field | Type | Description |
@@ -1588,14 +1613,18 @@ __DO NOT SUBMIT YOUR SECRET TO AN UNTRUSTED REST API SERVER__ -- The secret key
## Get Account Orders ##
[[Source]<br>](https://github.com/ripple/ripple-rest/blob/develop/api/orders.js#L20 "Source")
Retrieves all orders associated with the Ripple address.
(New in [Ripple-REST v1.3.2](https://github.com/ripple/ripple-rest/releases/tag/1.3.2-rc2))
Retrieves all currency-exchange orders associated with the Ripple address.
<div class='multicode'>
*REST*
```
GET /v1/accounts/{:address}/orders
```
</div>
[Try it! >](rest-api-tool.html#get-account-orders)