mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-21 04:35:49 +00:00
4e49b6a99c
Use example.com instead of ripple.com Co-authored-by: Elliot Lee <github.public@intelliot.com>
28 lines
1.2 KiB
Plaintext
28 lines
1.2 KiB
Plaintext
## request
|
|
|
|
`request(command: string, options: object): Promise<object>`
|
|
|
|
Returns the response from invoking the specified command, with the specified options, on the connected rippled server.
|
|
|
|
Refer to [HTTP / WebSocket APIs](https://xrpl.org/rippled-api.html) for commands and options. All XRP amounts must be specified in drops. One drop is equal to 0.000001 XRP. See [Specifying Currency Amounts](https://xrpl.org/basic-data-types.html#specifying-currency-amounts).
|
|
|
|
Most commands return data for the `current` (in-progress, open) ledger by default. Do not rely on this. Always specify a ledger version in your request. In the example below, the 'validated' ledger is requested, which is the most recent ledger that has been validated by the whole network. See [Specifying Ledgers](https://xrpl.org/basic-data-types.html#specifying-ledgers).
|
|
|
|
### Return Value
|
|
|
|
This method returns a promise that resolves with the response from rippled.
|
|
|
|
### Example
|
|
|
|
```javascript
|
|
// Replace 'ledger' with your desired rippled command
|
|
return api.request('ledger', {
|
|
ledger_index: 'validated'
|
|
}).then(response => {
|
|
/* Do something useful with response */
|
|
console.log(JSON.stringify(response, null, 2))
|
|
}).catch(console.error);
|
|
```
|
|
|
|
<%- renderFixture('responses/ledger.json') %>
|