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

Clio v110 (#1464)

Browse Source 
* Update response fields

* Fix typo

* initial draft for nft_info command

* update request and response formats

* Incorporate review feedback

* Updated source URL  and desc for is_burned

* Incorporate review feedback

* Incorporate additional review comments

* Incorporate peer edit comments

* Moving nft_info to new section

* Rename section to Clio methods

* Update dactyl-config.yml

Co-authored-by: Rome Reginelli <rome@ripple.com>

* Update content/references/http-websocket-apis/public-api-methods/clio-methods/nft_info.md

Co-authored-by: Rome Reginelli <rome@ripple.com>

* Update warning message location in the response as per code changes (#1462)

* Update warning level change in API response

* Move Clio APIs under one heading in the nav

* Update dactyl config file to group all Clio methods under one heading

* Fix file paths

* remove Clio from the nav title

* Add badge to note the version when this API was added

Co-authored-by: Rome Reginelli <rome@ripple.com>
This commit is contained in:
Amarantha Kulkarni
2022-08-12 07:14:29 -07:00
committed by GitHub
parent 7e57790915
commit b70b3ae7e9
7 changed files with 1268 additions and 313 deletions
Download Patch File Download Diff File Expand all files Collapse all files

544
content/references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio.md Normal file
View File

@@ -0,0 +1,544 @@
---
html: ledger-clio.html # Watch carefully for clashes w/ this filename
parent: clio-methods.html
blurb: Get info about a ledger version.
labels:
- Blockchain
---
# ledger
[[Source]](https://github.com/XRPLF/clio/blob/master/src/rpc/handlers/Ledger.cpp "Source")
The `ledger` command retrieves information about the public [ledger](ledgers.html). [New in: Clio v1.0.0](https://github.com/XRPLF/clio/releases/tag/1.0.0 "BADGE_BLUE")
Note that the Clio server returns validated ledger data by default.
## Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 14,
"command": "ledger",
"ledger_index": "validated",
"full": false,
"accounts": false,
"transactions": false,
"expand": false,
"owner_funds": false,
"diff": false
}
```
*JSON-RPC*
```json
{
"method": "ledger",
"params": [
{
"ledger_index": "validated",
"accounts": false,
"full": false,
"transactions": false,
"expand": false,
"owner_funds": false,
"diff": false
}
]
}
```
<!-- MULTICODE_BLOCK_END -->
<!-- [Try it! >](websocket-api-tool.html#ledger) -->
The request can contain the following parameters:
| `Field` | Type | Description |
|:---------------|:---------------------------|:-------------------------------|
| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]). |
| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
| `transactions` | Boolean | _(Optional)_ If `true`, return information on transactions in the specified ledger version. Defaults to `false`. Ignored if you did not specify a ledger version. |
| `expand` | Boolean | _(Optional)_ Provide full JSON-formatted information for transaction/account information instead of only hashes. Defaults to `false`. Ignored unless you request transactions, accounts, or both. |
| `owner_funds` | Boolean | _(Optional)_ If `true`, include `owner_funds` field in the metadata of OfferCreate transactions in the response. Defaults to `false`. Ignored unless transactions are included and `expand` is true. |
| `binary` | Boolean | _(Optional)_ If `true`, and `transactions` and `expand` are both also `true`, return transaction information in binary format (hexadecimal string) instead of JSON format. [New in: rippled 0.28.0][] |
| `queue` | Boolean | _(Optional)_ If `true`, and the command is requesting the `current` ledger, includes an array of [queued transactions](transaction-cost.html#queued-transactions) in the results.
| `diff` | Boolean | _(Optional)_ If `true`, returns all objects that were added, modified, or deleted as part of applying transactions in the specified ledger.
The `ledger` field is deprecated and may be removed without further notice.
## Response Format
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 1,
"result": {
"ledger": {
"accepted": true,
"account_hash": "10EFE192F59B3DE2A2BE5BCE2CA5DC83D066105696FCFC24C055359AAEBD6941",
"close_flags": 0,
"close_time": 711134782,
"close_time_human": "2022-Jul-14 17:26:22.000000000 UTC",
"close_time_resolution": 10,
"closed": true,
"hash": "D3878EF6C92B84678AE2FBADC40961A161A128EA54AE59C2775CE076C2AE7A85",
"ledger_hash": "D3878EF6C92B84678AE2FBADC40961A161A128EA54AE59C2775CE076C2AE7A85",
"ledger_index": "19977716",
"parent_close_time": 711134781,
"parent_hash": "D6DE54039FE5A22D86CD522F1A9B7794E487B74D9B6B8CBDE23F240F434B6749",
"seqNum": "19977716",
"totalCoins": "99987079398940307",
"total_coins": "99987079398940307",
"transaction_hash": "0000000000000000000000000000000000000000000000000000000000000000"
},
"ledger_hash": "D3878EF6C92B84678AE2FBADC40961A161A128EA54AE59C2775CE076C2AE7A85",
"ledger_index": 19977716,
"validated": true
},
"status": "success",
"type": "response",
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include ledger_index:current in your request"
},
{
"id": 2002,
"message": "This server may be out of date"
}
]
}
```
*JSON-RPC*
```json
200 OK
{
"result": {
"ledger": {
"accepted": true,
"account_hash": "10EFE192F59B3DE2A2BE5BCE2CA5DC83D066105696FCFC24C055359AAEBD6941",
"close_flags": 0,
"close_time": 711134782,
"close_time_human": "2022-Jul-14 17:26:22.000000000 UTC",
"close_time_resolution": 10,
"closed": true,
"hash": "D3878EF6C92B84678AE2FBADC40961A161A128EA54AE59C2775CE076C2AE7A85",
"ledger_hash": "D3878EF6C92B84678AE2FBADC40961A161A128EA54AE59C2775CE076C2AE7A85",
"ledger_index": "19977716",
"parent_close_time": 711134781,
"parent_hash": "D6DE54039FE5A22D86CD522F1A9B7794E487B74D9B6B8CBDE23F240F434B6749",
"seqNum": "19977716",
"totalCoins": "99987079398940307",
"total_coins": "99987079398940307",
"transaction_hash": "0000000000000000000000000000000000000000000000000000000000000000"
},
"ledger_hash": "D3878EF6C92B84678AE2FBADC40961A161A128EA54AE59C2775CE076C2AE7A85",
"ledger_index": 19977716,
"validated": true
},
"status": "success",
"type": "response",
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include ledger_index:current in your request"
},
{
"id": 2002,
"message": "This server may be out of date"
}
]
}
```
<!-- MULTICODE_BLOCK_END -->
The response follows the [standard format][], with a successful result containing information about the ledger, including the following fields:
| `Field` | Type | Description |
|:-------------------------------|:--------|:----------------------------------|
| `ledger` | Object | The complete header data of this ledger. |
| `ledger.account_hash` | String | Hash of all account state information in this ledger, as hex |
| `ledger.accountState` | Array | (Omitted unless requested) All the [account-state information](ledger-data-formats.html) in this ledger. |
| `ledger.close_flags` | Integer | A bit-map of flags relating to the closing of this ledger. Currently, the ledger has only one flag defined for `close_flags`: **`sLCF_NoConsensusTime`** (value 1). If this flag is enabled, it means that validators were in conflict regarding the correct close time for the ledger, but build otherwise the same ledger, so they declared consensus while "agreeing to disagree" on the close time. In this case, the consensus ledger contains a `close_time` that is 1 second after that of the previous ledger. (In this case, there is no official close time, but the actual real-world close time is probably 3-6 seconds later than the specified `close_time`.) |
| `ledger.close_time` | Integer | The time this ledger was closed, in [seconds since the Ripple Epoch][] |
| `ledger.close_time_human` | String | The time this ledger was closed, in human-readable format. Always uses the UTC time zone. [Updated in: rippled 1.5.0][] |
| `ledger.close_time_resolution` | Integer | Ledger close times are rounded to within this many seconds. |
| `ledger.closed` | Boolean | Whether or not this ledger has been closed |
| `ledger.ledger_hash` | String | Unique identifying hash of the entire ledger. |
| `ledger.ledger_index` | String | The [Ledger Index][] of this ledger, as a quoted integer |
| `ledger.parent_close_time` | Integer | The time at which the previous ledger was closed. |
| `ledger.parent_hash` | String | Unique identifying hash of the ledger that came immediately before this one. |
| `ledger.total_coins` | String | Total number of XRP drops in the network, as a quoted integer. (This decreases as transaction costs destroy XRP.) |
| `ledger.transaction_hash` | String | Hash of the transaction information included in this ledger, as hex |
| `ledger.transactions` | Array | (Omitted unless requested) Transactions applied in this ledger version. By default, members are the transactions' identifying [Hash][] strings. If the request specified `expand` as true, members are full representations of the transactions instead, in either JSON or binary depending on whether the request specified `binary` as true. |
| `ledger_hash` | String | Unique identifying hash of the entire ledger. |
| `ledger_index` | Number | The [Ledger Index][] of this ledger. |
| `validated` | Boolean | _(May be omitted)_ If `true`, this is a validated ledger version. If omitted or set to `false`, this ledger's data is not final. |
| `queue_data` | Array | _(Omitted unless requested with the `queue` parameter)_ Array of objects describing queued transactions, in the same order as the queue. If the request specified `expand` as true, members contain full representations of the transactions, in either JSON or binary depending on whether the request specified `binary` as true. Added by the [FeeEscalation amendment][]. [New in: rippled 0.70.0][] |
| `diff` | Object | _(Omitted unless requested with the `diff` parameter)_ Object containing an array of hashes that were added, modified, or deleted as part of applying transactions for the ledger.
The following fields are deprecated and may be removed without further notice: `accepted`, `hash` (use `ledger_hash` instead), `seqNum` (use `ledger_index` instead), `totalCoins` (use `total_coins` instead).
Each member of the `queue_data` array represents one transaction in the queue. Some fields of this object may be omitted because they have not yet been calculated. The fields of this object are as follows:
| Field | Value | Description |
|:--------------------|:-----------------|:------------------------------------|
| `account` | String | The [Address][] of the sender for this queued transaction. |
| `tx` | String or Object | By default, this is a String containing the [identifying hash](basic-data-types.html#hashes) of the transaction. If transactions are expanded in binary format, this is an object whose only field is `tx_blob`, containing the binary form of the transaction as a decimal string. If transactions are expanded in JSON format, this is an object containing the [transaction object](transaction-formats.html) including the transaction's identifying hash in the `hash` field. |
| `retries_remaining` | Number | How many times this transaction can be retried before being dropped. |
| `preflight_result` | String | The tentative result from preliminary transaction checking. This is always `tesSUCCESS`. |
| `last_result` | String | _(May be omitted)_ If this transaction was left in the queue after getting a [retriable (`ter`) result](ter-codes.html), this is the exact `ter` result code it got. |
| `auth_change` | Boolean | _(May be omitted)_ Whether this transaction changes this address's [ways of authorizing transactions](transaction-basics.html#authorizing-transactions). |
| `fee` | String | _(May be omitted)_ The [Transaction Cost](transaction-cost.html) of this transaction, in [drops of XRP][]. |
| `fee_level` | String | _(May be omitted)_ The transaction cost of this transaction, relative to the minimum cost for this type of transaction, in [fee levels][]. |
| `max_spend_drops` | String | _(May be omitted)_ The maximum amount of [XRP, in drops][], this transaction could potentially send or destroy. |
If the request specified `"owner_funds": true` and expanded transactions, the response has a field `owner_funds` in the `metaData` object of each [OfferCreate transaction][]. The purpose of this field is to make it easier to track the [funding status of offers](offers.html#lifecycle-of-an-offer) with each new validated ledger. This field is defined slightly differently than the version of this field in [Order Book subscription streams](subscribe.html#order-book-streams):
| `Field` | Value | Description |
|:--------------|:-------|:----------------------------------------------------|
| `owner_funds` | String | Numeric amount of the `TakerGets` currency that the `Account` sending this OfferCreate transaction has after the execution of all transactions in this ledger. This does not check whether the currency amount is [frozen](freezes.html). |
If the request specified `"diff: true`, the response has an object `diff`. The fields of this object are as follows:
| `Field` | Value | Description |
|:--------------|:-------|:----------------------------------------------------|
| `object_id` | String | The object identifier. |
| `Hashes` | Object or Hex String | Depending on whether the request set `binary` to true or false, this field returns the contents of the object that was created, the new value of an object that was modified, or an empty string if the object was deleted. |
### Response When `diff` is `true`
````json
{
"result": {
"ledger": {
"accepted": true,
"account_hash": "29E8799E80245DA68AE2D9C4A454DF3E8FEF5B66C520E644DE0756E548C6897B",
"close_flags": 0,
"close_time": 711135301,
"close_time_human": "2022-Jul-14 17:35:01.000000000 UTC",
"close_time_resolution": 10,
"closed": true,
"hash": "C769F00409D574A982DC0CC071A244C5507D9E2269404957B78081ED8F2FCB1C",
"ledger_hash": "C769F00409D574A982DC0CC071A244C5507D9E2269404957B78081ED8F2FCB1C",
"ledger_index": "19977887",
"parent_close_time": 711135300,
"parent_hash": "29BAC714E9BB7DFE9BE3C8B4AACFDB184389388340A4F3B09CC61A39BAFC3705",
"seqNum": "19977887",
"totalCoins": "99987079398939527",
"total_coins": "99987079398939527",
"transaction_hash": "0000000000000000000000000000000000000000000000000000000000000000",
"diff": [
{
"object_id": "B4979A36CDC7F3D3D5C31A4EAE2AC7D7209DDA877588B9AFC66799692AB0D66B",
"object": {
"Flags": 0,
"Hashes": [
"A17FED77F200BF8FC66050BCFCC87241DB53C418B3B3C8794C857AAAB76C21EB",
"F991F764BA7B44B5B28F7AC8F03F2BC03B1647AD355CE0F0F91D3B500F862959",
"06523FF3694A078F2DD073A728145455EB451651180C6B0EED1557B657C6C07D",
"69D5C7A206A34CC4A1D21A9D2453E6D72526EA0DA712009F215AA614C259A333",
"94453F6FA048C153A7124C249A7C3393D1A3B4E34A508872A3AA4FE89021221C",
"406FABC4A1C9A30300C814F6B083C00F16568840BBFDCA04369A545CF248472C",
"9396907A543546ECF48C6417373705514653ACB4E585C009EEF525B51CE1F155",
"14082ABB45AFED62BFCDA3CD0465BD17545281C3D671DEC82A837CBEE36E470A",
"1D4D19B06024BE49333EA6C010F9721C5C1A36A5C08D22160945247D3FF9F552",
"91095028948A56A16D8E17488057C27BED696B8E359BAB0D7B8510BBD5F0CFB7",
"FC073AAF3B07260545DCAF0BA0FCFBF7673302D972A534CC8EAB1CD5C4CC73EE",
"4DB17A22F0857992E2BA75C4C15C39B0D420EA26AB6FA862B54E2D65C739117B",
"CB44073EB0A174C4757F453335A5A84848AD899AD09574883946F37DCDEA90B8",
"0B285623C693432532418BA783CF6D731CAFFC312566398B27B67C1B856AACE1",
"5024CD26CE82294E15656CCA0E350284ED6EF70DBD4E4791017F3E4B396D42F5",
"F0E4B4331D5B5B9BB1B43232C8B50E9EB17CD4F6817B04C3AC263C773B44E222",
"7CE5AA21BAEF20DCA4384D469451F6B9BA7AFBA265FCA83B48045C7D994E8BE8",
"91F8A45B27C8DC825157633ED5AE3435F51D5325D29F2F8547D3849F59812CDD",
"520B119EF4ECF9AC3F1B247621A04F0DC187CA6D756B6614E6BCE05A22839C8C",
"EE87D8EB08BCE989C87D530EE4497F5B59B82F859C687E49C6629F34623CF4AE",
"965933B82140D8BC04C324E075AB3758F82F17BE610D12306614A4B1F3695270",
"EA1EF4CECA2EBABBA5A09041C186352B3A57F4496676DF0E4E743794CF2D7ED5",
"A261123CFC1675958992C604778535208FE9C783AA77107393EC1E290D7D3ECF",
"5F3F22362E969A5E7479BB4A9FD31BCFBCCDB66741F49CB72755BC2B76A1D310",
"1BF9D357835E4D8FA82AE99FA13F389F502401E59600F2B72E4B1CB703A54363",
"59A17903D6C8FF3F36C327E207AB54293163A8AA4A3DD515F2C677B736396BAB",
"308905A9E623788DE1170B396AD379863D5492B490D6D56D68F3DDA41CED7F39",
"B686A8CBD0B5464C74B7D7E3AD04D055E59C7FB558B4F65D61FDC005AB91950D",
"81831141523FDEEEF91BA883B0B394D8D608C2353936123F88B4C27F823E5F32",
"DE2BE267BF14EBB26696070989BD229603985CDA105B186C2987C6CC9A0CB83E",
"E54358313465A1701F94806969E07D392AA5E9A6DE99A37E4328B9C9736630C1",
"02190060960D241F3182D4E8CC154D2DAA8224CE3CC1DCDB1E21CAC65B56D9B0",
"B02916AF6E46353828988E785C2F0A26F8CD6196F5905AB4DEDF7034432FBC3E",
"3E95827426FC91549A8E9A80D6CC99997646F6B26CD3F625D94064BA16DE97E1",
"1B83060E2DE91E889FFCE8D0DAEC810197C026EE0F037E612732639EDED3EBCD",
"A8EC7EE25A6B6C13AC6A006F3397EFC8FE38829EF273469186CABE5B529A40EC",
"B00AA09BC4A6180967DD6BA88BDB13F5F59EA4E9C074B752A04DF7C515DF8504",
"45CD713F10A5ECD06B32A2B15E63FEF211852E8BD56B813362D16C7413948785",
"A749FC031CC69E10476B7AD751B068F32DB9192C9CBCBD7CDB018FCF5C1B0934",
"28BC94EB8BC5A0A3313CD825FFC824454ED64C60988D530B334C3112621005AA",
"18DA83251BF498CEFDD189B7894E70ED2BDE832183C4C846B4D6E886B0749CD6",
"4DB4B88C5F4638816E06D880E55DD83C61747D0235C96E1CE1FD709777C20BEA",
"CED44414A9AA99BFD709B7A9072170CB2040EF31D5E84552A930E02CAAB2301C",
"9566A3A6E02FCA0648B67CDACE941BCA7D243D1E2F18742E50EE83C1C8950A19",
"0100F9B48D0999BEBBD18500036741B34E7FC395F155FFA81263EB772C2E1178",
"867719FDA972F549F2149341FE8089A09DFA590C55B7F682A4BDEAEC14A32EEC",
"12C96E5C7D29649AA86FF17969B13978DCBA004F691D476A8AA88EFDA318E5C1",
"8001BD1ED9A0772DA5C89144B56B2504F90329C06E05F4052862EA5560021448",
"D3F85FA0E6B948F05578B99306247B569548A976773DBD0A7811CC8FD62A5033",
"A2B15A5E7B8C3912C7FE9BB93B98333B00AB82322F9759CC43ED6D7BC25F48DF",
"3C7D539FB2D34B20B3BBFFBEA05738560A3811AC496BCB7D504041250D4C393B",
"D5B91302F8146E5BC0FAAF08BE2C228CCC17EF192A423CCEDE1A38A604D9E842",
"F4DBF016BA3836F3B6B5971D1308C04C531FADBD6E74EDB03822851D8C1D5A84",
"EDA6E3DE8138D6129B3A11EBE98F676F66943158E2ADB0E5E548EFCA124C7F7D",
"19EBC639A176F903A739C1C375C240ED5EB58B5D1FB6DF15B3CE4AD6B04689B8",
"E015FE6FCE6C587605A7918ABC25CB37BFABCD7D49A2C7EBDCABC490AEDD90AB",
"9684F16CA2DE7C8056F5125D2AF167E8D3CB5FD8F9A12D87D9D60CE46F098BB3",
"EA9160D3B05F0DFF835AE2AF054BA0FED3DE6A381E11AED991E0850EA1D28A7B",
"2483BA35393AA70856554220E0A3AF07C33C6DB03BE12611456E202A0549FE4D",
"FD0113CC43B968461C3F2747BAFD05878A406BFB77B2DC871CA38F437BF210AB",
"F0DACE2C90812B32803F5D5BEFBACA52CF2F356D7DABD617D9EBBA97328FA785",
"3A0AF0AD0C70DCA0133030A00AAB6B988C898B85A46280D8E76D276CA338424F",
"44EECEB56CD25464A250C2D1A6F8229A2764BBEF7D0055136BCEF30891C38EDA",
"877D98B96F97C3E60F2943D1B8549FE4AE5028404595E5BBB202944AC6F01A60",
"2D315749EF112D77ED3678AB490EF8A57DE306CA8FBACF92C488768A96A9BCFA",
"4369B3388623807E1FC6CDF6903B52603FE4CB6B9BF077C59F8B13B51977AA69",
"56B0C8A81165767A2ABBA57DFAE643EDF4939E90812357C57D771494BF53842B",
"6A6BC82CE98722D24EA37A5BD6147964B80EAB15FA92040ABBE5EDC2091926AB",
"49AF43F65FCA39766EE5A8E1A350728188EC7484415A08C99E1B5D20D3CCB02C",
"8EEB0C0B13C8F4AFC1290108A76A694657CBD88D386C01FAE14DDA3375500B2E",
"3B1005BDD07BD695EDD5E03F82B491D716E1385667403E71359CF4AD1E1A16A9",
"75D9C054146CA170317679319D5B4EABEB43A5BC54DC8C76436E3FDA419FFD02",
"28B85444D0F90113D9DCF445EE1988EE228980103F3E285ABEF1D74EA8D739F4",
"086064E478FE929117878CB7BFCDB615E3E9F2386DBA414922121C026B112A57",
"AD958731124D7ECCA778B9D5671C61E6D7F45FB9DFED3ED088A48BDC9549BF64",
"209D7728CBFA4071209906222B90EE625E4C2204FC26DDE4C07C23079AF75A9A",
"565907A56C26BD5A51CC030F43A06E3A147D468108115D5FA77E345A6E565F6F",
"1D1DE732390C20EDBDDAC5DFC6818A6F0E016C50DC376AD2CDD3F24EF1FA1855",
"A864A423696798807F2FB532F1708FA35C1DAF6C419E67E6E773A6BB129F8266",
"C47D3FFB2F918FA865597A668ECA393F9FC2E429CF0751E970A03C7F48554982",
"D033B2D1E8A2CC77FBE576D074294E80E6C6018802E62FF7BC56701E54A00BD9",
"25D569F5D84842FFEED3A05178B6B9E582E922B43A8CC29F1146E34FAEBBDDD4",
"C56A6197504AD536CFD9A0C26599F6D3E305CF77354CF2D7A33546DA24439B16",
"28F8DB51BED3DDD90194D1452B18C2612C65FC09D77FE31B271C59291C0C2E06",
"D6DE54039FE5A22D86CD522F1A9B7794E487B74D9B6B8CBDE23F240F434B6749",
"D3878EF6C92B84678AE2FBADC40961A161A128EA54AE59C2775CE076C2AE7A85",
"6DF891006E4D4840263C561C54135BFE78FE766A5CC241DDC7A0563BCA4E4C5E",
"FE2D5BB3051F24F6114A7DA14CD393E4187219F52DB83CC0438E0F0B1B350874",
"39292A3C8E56BEA306D83441ADF3F0E65C02BE1DAF3F66F8B95EF46FF44D2487",
"506E1F0A25BE23A46C7483D23CC94583837411D79DD446219964DCE2C0807B0C",
"1D4327D8480B5EA7A61AFB1DBA977D2621372227D5FC55FC90081B3675082DC2",
"39A957F6982825A34ED12AD63BB1DB76BB6C9E725C28BCDA198F62876E0FEE44",
"64C05FA4D16991A613F13655474ABC52C49093334A1C844F5F0682560B0BEE70",
"A4E4AF4BC5B670F2726146233CCA99226EDE61468A26EC4378C919A1D0CC7162",
"6AD5D147ACBA2AA94D19AA4CF8FE8A92F11D57DB7AE21CE2226103CF1B4D49EE",
"7764C4EB977E2E40825593AAC2B51FF8D2DC6E29FD8F257C235D009D24238860",
"DECBDC6150DA4CA92272AE45CBAE9D8174E84FD2D0053707778A3FEA4FCE8961",
"BFED2884BB6E0DCD3BC0E91326CAF674A449D05C7AFAC95BDAB3D51FFBF369E9",
"ADF69FD7A3273D709B2FDD7FC4A2C43D6D0D6BCCC0AF65FDC584B543FEF68240",
"FF3667A56CD39221B8F2B22A479345CBAB9E7CDBA43A0356E694AF58D347D2C9",
"4DD651F3A6E1B3EAEFF384F21C04B2BC39EEEBBD016180781CC007842F5C9DC5",
"B7FF750CAB3F806DD13ED55CB54443BFBA616762DC32891CFF55885407844911",
"24CDF209FBCFA4F10D46CCD4B05C8A80E030A212C6F53FD2DEFE93A0E64A2848",
"E3EA5323ACA4611D84415B787CA74B0BFD9FFC37E1BD862498A8370CEBAF6AA8",
"8D1A5630B0871D4E27F5B13E73CE313C7D65E4694541877940E6D113CBE6D5C1",
"FADA7F6865EF29AF7C9485E170D25C03B96354E8E419532090A33FE11E5C536F",
"A13BFBD7E04AE200E7BF91159B63B8BB6B867B07905DE927515178DB786ABB10",
"0C7B5ECEF3C99096D29307EFCF2FF2C058EA8CAB8E8CE45602C877EE06C8E428",
"B58FF112CCAAAADBBE9CF2B986C84F6F9E63E21AED202DD6A8154287F1374540",
"0466E0A51610D718CCBEB76DD5375B8D19401F14F0D1FC43BADBDBB0CBC2E252",
"5D78C471A058971A621AAA03AC8B48629BBDCBA566729BFB9ABCD57F34C7431A",
"52154C4764859925DCEE21722E782B9661751CA5E12D5C6F20CB25329946FF42",
"D1157510A1F7E60DEEA252C1556D442529BB85FD663ABBE0AB50FDBEB2E6B102",
"AFD343935B0A415478B1B939F7F65B01ACE8697E600D2D4876C44322B4F1C7E5",
"7009160F2CEB809C9D3579471F2AA4375CB898AEE4D75610A1597A231DDCE48D",
"91908F58250C01130E5DCC2F4E27C7B1AC4F3DD2ED37D89903EA1C4814610215",
"F91F97F8B7ADC47DF97C57DBBD9172F6F474519BF98A3F191C36EDD5FED60FA1",
"681992EE99027FB7083F6801F4FC0C42342188D4C19977A723F922DCDD7D96C2",
"431EB9959F3D1FF3902BD92710E9A82D2F2FF2E21551A9A4704CC5D021612CB4",
"94AD216A9B3080BC850B1E4A2F3FDA73000806070FEF53A63EB993BCDC89C380",
"E1CA581E35FD56A476A09FB1FB69E0F756538FBFE8C7784C38042511AB9C98DE",
"11C388D35E712ADC97A3D0AE46FC0C0CAD8F4719255A19A3882194FB2DF5F7F2",
"68D34928D77FCB509A8A06B6EB7C674CDF21E53BC5BED834FEE948F2BE3234AC",
"451A0520DFAD303D5564D9E383C4335EC457C870D4BBC62C33F3B229C41599AF",
"183155CAC5C01A29209CD866BBCCDF2B50EA3D60450AB8E6B69B6F85509C60F2",
"02494D95424824D3F83C9916CDF0C1CA0FAAA1C22B8E7647D16CE84C15E9850D",
"4D140E49AE22792B21B6B96C7DF003954B34393BFB915C18AF1CA7B98C83DC45",
"21735614AFBBCF9D109DCD83424024EE8009292DD8D75715C3A6E1F96250B7DB",
"82EFBE40A7B810369E7C39C199D77061E129CAE36FE4A0A000811A23A7AD7E63",
"AF3CB3F6F3B9D086390BBFC6FD3F8FF2918D58E2B2032D89E83879174F480E3D",
"21848D2B5F50AAF2044662483386A629EA8162995E58A479625F9A1C617A01E7",
"BB8B7E9CAF46E29403C649613AF16FE8AF37478AFCE240BE6C0BC3F54A6EB4F1",
"F2874B80E64C57F8FD1DDA598FBEFFB4B2E6CECF3A984DAEC60F184ABFD2C03A",
"15CDBBDA11931E1D24D37218E65CB3CF08F0E539DD9AB942214C05B3E494B6F0",
"9C210C63F0679B59DA6F003A0C5D6F7E2DB4EA1406BE6EACF449D217C285E037",
"192C9D0C5A49989BCA788F1BBE63B58556BA0E433BBD8ADD4B863D1C0FC356AF",
"03F177E6517BB75C395B4E6A7AB45B8AFE0E974210828713AA02DD47ABD1408A",
"7DDEBAF7B185001AE2BBE964380753231869474CBDA1EC95600DA8E1A02646B7",
"A85AB657FAEDBEB7131FEACDC65347EE08B4ED13D1C72A49CC2B5F8508A5B0CB",
"9C6E9109DA0B5A513DF5E73392AADD7C6C0496C940BE60A9B8416C3D4B556EEB",
"99E68186022471A787D7A8CDA6F75F067925A374B8A429EDC7F36E064AEA4199",
"A4AE86CA5A78E2145856B3A1D3AB7C6F0907BA46978F50633E48049180D031C0",
"EBC6B139FB1EC3E9E24132689CA092C8672EDF356398D29100D9F56BEA81BABB",
"C595DF4DE3C2127C9A6AF2136E6179341D9DF5155A4AC514B2CDD2C29C4AA07D",
"29612714CE0AAAEB97B287F0C5ECD38782FF9BDB2B18D482679E64557223D380",
"DD025B92754F403EA9BCCC588CEE41F7AB64A7458757EAFED1025E193BAA8CFC",
"0E32604081E3D7349225F7F9379E291A69CD78D0C65D332DEA30FEE3795E0F4D",
"CA6F59B04FAE47133310217A832300402B947163AD630365E9BADBCB1F839634",
"1170E9481115804233BB48DECE4A40FC3822D90B304C1842FCF31185982C6A26",
"1F5C266D7C98931AE2FE24C540D62691534CE19D3E0705866F2BCB4A9A7DC96D",
"ED5EE281D36BFD1AF424C9893D81FC89A7B7904B46CBCC73878FDAB881D34104",
"126EFAA40EE6813C63D0C98776E3C1D367CDF082A1CD4BEAD9AEEA0F5B381BF6",
"41B9BAB0370A20827E8D982CBD998A9F3061DBF4E8D8D5FB9A94AB88ECDFA9E0",
"AD84AC38922A4F7419454303357C7F35694D428C4DBA055A73318647A28BBA22",
"F1E13F085E07E8B7B096A94046254D2C753F0A897228F82FA8E8E4470E8EBC84",
"E56D730E2A64F28B5D8F1F622224CA3DAFC9E8977C2D7F6916B668E6F5AC5FEA",
"5176BCD5B49F51EF0357BCDFA99393FF870C956548183C45CCABE3C45A6E0210",
"D0BAF08FBA5DBB1C56B962D799F5A540227A0A730DA01A29709F1069036C0E4C",
"4B6864224578CC821F3FDD8481C9898BE2D6F7AA57E0C088A4190F97361066EE",
"8C82AF844701C4A460E6977AC3138FCC0A16DEFB86C30A1DA5D850E79F4346EA",
"DC494D03BDC80BDB671DC34580C85101B4757C6FABE07B96CD50DCA08F870EF1",
"7E01B6E68F72C59B819D9FE3A427896EAF6976F54D11DBAF4E4B78AD0F4F94CE",
"65DB13E8EF98054BF5EB1B7B458B37D09F062F1ED5AD29CBCD655E082CFDF948",
"87377F31ECBB1BA1FC8D2B78EBDC3BC63F034C81490097C445A43B571C24CE41",
"895B2CD5B1F669A35FBDEF28224126F433758E4A95A5D2503D9058BB70ED676A",
"503D2DA830018B8F422A32409D71DEFFE1F4DA682236B8218607191EC01A3A7D",
"A86D61D03AAB6D516C93F90C80C227A137776B7FEBE3E7BA6F7DBCB18FA800B9",
"E0E88839EFBF8E78AD5981928FC6B75BF1B037534CB20D8A19B173183F726D96",
"1E64DCEF5EAD556D1243CD60AAC9DC8F5B6335ECDD3E2A606A2C504BDF24A752",
"4E3426C8BF92F0B713D59381A865EC646733BA6504907F43D3899E0437783D0F",
"47A43F68C85B560877398BF1F762B69517C43842EDF90D1869C5FFA3D334DFD2",
"1D2077E03065C4B1B893B09A1F9ACFAF4CEFB8EFA48110ECFA88BFC83EBDD02F",
"FA46B288FEAD5D7314855929BEE8E7E6FEED199B4A8EA45DCB026DE0A2F85DEB",
"CDEE9069327F829ECB476103E859033481B1ACA692527B2A117F5188259CB642",
"8C892E4EC406900DC3632A872849F2D58A248E8089EEA5F95B4650F2B8140037",
"9F5C5E1017556B907E60342E8D146556C41A8E125F62101F3E11023FCAB0FA0D",
"A97DFE953D243B9534C4CF446D58928B3DA526A52739C65C218D98E89AB8F154",
"EBF542E9C22DD349ECE2BC90BFA78412F97E45315349F7D6EC530F266A10874D",
"C20330EDC46B8C3DC3841AE2141BF523E5D82BA7453E7C80772EC545B8D74D68",
"5AF5470AD82C035CAEE8822AB8E23F86C87A9304069BF4DDB7B4329C9D99CC95",
"899D94ED8FCA53556E2B679F007298FAD93FC7E948337918154907E8AF44BF88",
"0CD167820E508D58E0EAA828C611BA83E483F31316262AF4DA215A6BC0E049F9",
"D7F686491E837A42A82CEB1209344EA906ABE1D5D2A88A09B3DAFAA41D174CEC",
"B2BD977BE83845585E5BF100DD8F1D074B97B863EF026E5B3E5CF58610A49B76",
"85ABA1F4F4EDC96E21491BDA3B0FBF9D24F85CA031C2CD7885F1EFA70D32B4DE",
"4F88CAC8248F7BDFFBC6FA84FF90041CEEB7E6F37480BFEE121CF3E56D3A79AE",
"5D2BDDB71EE422BDDC673E435121257D4A0603ECDD53A00FE2A5F7F2D0301173",
"198493B9CAAF02641DF7BC6C0F18B45C12E036EAE757F3465EF973924DF8C77D",
"E4AE4E3F8C34122B47E1D5B860911CDC767DAFB039C005961175E2439BF78DC5",
"B5BB5640A47DA626D65122018BD3C415DDBE2A1CAA4407B8B079CEF0C304AD95",
"BDB7AD110926AA63846409D5FD1A99AA1BE868AF245389ABEE31F14EDD15EBB1",
"D8495120CB075C928C72CD926B94C99F5254AAD2D6E244BAFA9A63BA52BD960E",
"D2557CD093DCBFBD3AFDB8EFD11FC1E6F413EEB2761749EB200A872A3D2694DE",
"571BC9B0877BBD6367B06671C27EAF34F816CCA2C21DCE5897B0EFCD0D43A2A3",
"04B1D993665ED4D933932058FD8FC2B94DCDFDE047548FCB3A01DBD14635D077",
"62C1D9B265994D0E7771EF89E862EA78DDD92393AFE0CE8AD8CA88CB6704D1E0",
"900D28DB3B3D291923AEF1D21A4C479C03351C5F8BAD5466B8342D7DA27D8CBC",
"1DE86AADC71CA909F70481703077EE060173D6A29793C310C580B98ECC874201",
"4E0370E993DD3582AF5E6E4305DEDDB827FD54CD724FB1D8C0C9D3233E47BE14",
"A3DB94469E15C3F6929B2D32F738175094927B5BBBB0B604C2D53CB06D346127",
"CAC99E91ED58500BDB307D5DE552CC8C47904475C80BBE11541E893BB1E12B4B",
"4765C07192C891F5241B66A30A97C97FBCC8F4CC69BCB1AF6E3300785623F3A6",
"45BF472F5B15A434F566CBB2FB47C5831D11E4B9B223541368E8548D4C55B59F",
"3FC3D33C9C4A183DA4637E4EF274E8FD33B875BA0FCC04C651FC7C4232B16FAA",
"A98C78E925763C6C1E5042C84A67D41F88270ED729D69A26201E07A5DDA5230F",
"50C0C03269F1F6F7A2D043E87D77E33C90A1DFA89D1ECDEAF4A60C58F35B5A88",
"DE165AA3966F0563450D0574E640299CE74F7F34DCC91B6611F28D5B4F4787C3",
"5991D443A65155D51146CDEB92B20DC6741F5DC69CF9BB09D2143B1FB6CA5DEB",
"7B277027ADA02DE4A2ED276DDFC25A24DC192C4621C690388214EA3A3702D160",
"6DF9246E01CCBB2EB84D45042759DE38626E31FF13C96B96D7B3D810B913C267",
"E57254EC7240FC6EDEDC06472720C85BA29D7767B558D80912153A9AC80B73C9",
"D82D0B64692718A90F92DEA9B86DD919CAC9D00E81D67016622D9EC45ED881A9",
"E7422CE9EEB7CC82B3D4DF2B269EEC0B1D4600DC6CEB4378331724D9B27E498A",
"D7B00E067380396A385C16E83B269DAA401D37983B88C2170F3F5868A8AB12E5",
"E5C8DB25AD8CA4227DD22B37A85ABC550CF10EB22107B9300ACA996CDE0FAD43",
"149EA8F908855BEC67176C2FDBEE3DF60A96996AFFC3CA29BCC19A0E2612A3ED",
"7D30BE677279B82584374E603FD195AA8141F2E7F4027178C86B7FB4489FC824",
"B3516D84A78F96AAE074D01FAA58711E79705D12164894B89A5C65FF8A459379",
"149E3515ACADD2514E3C452CC02A0043F064FC245E559A6F184F60E0B0910ECE",
"7D58A24F7D64BBE0B394F416F332363FEAF205B0094347C4EC036D3B3945103D",
"1433C2844DFB3910310FF1E1C33DFA6F6B687ACCC6D306B3D5EBEA4221B377EB",
"A1AB11FE6E3AF3610BBB0FD4294A6B0DEB8064FEEFC082AB3D02F7A9FC455715",
"E68A28C04129B4193082270FA2CCB8C5616EA265F43CDF3875C7FDB28D6E7FCD",
"05C99D4ED3F3817CC771B5C6C44A5C8D1DC12E104E2EE9D68FDED0A09AE04496",
"998D87EDA73CA171AAC58BFD81AF491655D35A56F39499808F0D615457DD15A3",
"DBB89E5A3DC843EBE9FD76D2900A5EAE13B1F0DD94C4ABD79419BDA49C0D198F",
"1B8CF3D3641353C5B542028D693EB48B234481EBBCDBFFBB4296E2F3F27EF73C",
"F4E458B405F45F4EEC826BE48C5C1DCAE63793D5BB9F594F92C67A3BADA0C22B",
"4C7E38C43A22C6B24060DCDC082F8A870A9B7F503863913AA231CB1464EDEBBA",
"BA1B4558AA11B62016A63D9A62C70D9F1F3D63596EA1FEB48B762C88E499A276",
"5008C69B9FFE9228582C1885E376DDB7F97A32F9D30320A3B6643703E9B36755",
"B8A8DF116E86B84732A2CDD730CB869783581CFF552EBE29B76D249BC03CFBCC",
"64CB6269F83A4E04B1484EFEEF680DF4FD53DEC015E04DAEC3B8A1AC320E64B9",
"15FB1B492A8F53CA3E3BA2DE62504586A895E3F1D9941A491CE44B5676355DA8",
"B815A256260EF5B646309EAF63057C70B83F82927D39E2E8869A4D4D9E4FFD21",
"5F559A5FE8A29C9959508AA33684F71BFD387395330988055C0062CA756DA44B",
"6A4E1C27AB06D35675648C9FC6609D55E778972F70FCD6F28852116BCE56DCB9",
"0390537EF63BF56857F6252E0CD6151C0321AC683AD91C5CBB59A1FE93285506",
"9717BEB3BF2DBFB82E7572458553D0E24C9DEA2B752711813AFA7E36235B6EEE",
"BAE3CFD5371A27B256970B4D94E104D65440EEA94EEF55FE2FB8063D0BA31776",
"21CA517FFA45C251FCD86ABCCBB906BE365B5A597BF6283BEEFF99F562ACA922",
"5336C2C2A8602FE29AA1E67F628CEDC3392B66320A995694176BA34D4CB17C38",
"70C73DC0C72B1D95821F0EA13D4473341BB470044662025D6A228D084DA3859B",
"93BFEB7E283134FB6D4DA2C8AF413CCA5E7EE8903ABA5F6D48BE9BA00798852E",
"3A4B964920627F66A11249A5EF68A9FAC468A2076FC12BE725A5C343E83BCE95",
"13C233A526E35A73DEE0AC36909CC7522C39AED9D42C59D4D7CF646B3F0A09DE",
"94F66D4C66295A3ABEC3D30279F1BD734E09407384B6845770AFBE24E2CA233F",
"C5F9578F580F0111C8728740A39D07957DB8611769676A2ED02E6648B847D865",
"D2BFD4D322A5F37CDCAD66952742943EA9D29D66D22EA0294781FFFF8DE8BD74",
"CF5B95D57193FDD94C3788BC9BED36762CD6B0231CAF5F38423BC7B9B8CCD625",
"FB311E71ED73477183EF1578D152626FCA7E7B2A93785AABF29C5A6267E46953",
"D00F187A37A8E4BBAF6E9041893D30B432CAAFC1B175A27B45C5344AFE3FE462",
"0E9E27E3AA04E9DD3F77146FBE4065CF877EB1DE0555D9FB9EE776EDD7F9B78C",
"7A9D5ED47D42269852BA4AFA373C8BED88F99BB7C4ED9CC4900D2585A3832DD6",
"D7F92889EEC05282AE1BB4375FAC645B968EC23B0AE47E2206496D3E12770BA6",
"29BAC714E9BB7DFE9BE3C8B4AACFDB184389388340A4F3B09CC61A39BAFC3705"
],
"LastLedgerSequence": 19977886,
"LedgerEntryType": "LedgerHashes",
"index": "B4979A36CDC7F3D3D5C31A4EAE2AC7D7209DDA877588B9AFC66799692AB0D66B"
}
}
]
},
"ledger_hash": "C769F00409D574A982DC0CC071A244C5507D9E2269404957B78081ED8F2FCB1C",
"ledger_index": 19977887,
"validated": true,
"status": "success",
"warnings": [
"This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
]
},
"warnings": [
"This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request",
"Too many requests"
]
}
````
## Possible Errors
* Any of the [universal error types][].
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.
* `lgrNotFound` - The ledger specified by the `ledger_hash` or `ledger_index` does not exist, or it does exist but the server does not have it.
* `noPermission` - If you specified `full` or `accounts` as true, but are not connected to the server as an admin (usually, admin requires connecting on a local port).
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

148
content/references/http-websocket-apis/public-api-methods/clio-methods/nft_info.md Normal file
View File

@@ -0,0 +1,148 @@
---
html: nft_info.html
parent: clio-methods.html
blurb: Retrieve information about the specified NFT using Clio server's `nft_info` API.
labels:
- Non-fungible Tokens, NFTs
---
# nft_info
[[Source]](https://github.com/XRPLF/clio/blob/4a5cb962b6971872d150777881801ce27ae9ed1a/src/rpc/handlers/NFTInfo.cpp "Source")
The `nft_info` command asks the Clio server for information about the [NFT](non-fungible-tokens.html) being queried. [New in: Clio v1.1.0](https://github.com/XRPLF/clio/releases/tag/1.1.0 "BADGE_BLUE")
## Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 1,
"command": "nft_info",
"nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000"
}
```
*JSON-RPC*
```json
{
"method": "nft_info",
"params": [
{
"nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000"
}
]
}
```
<!-- MULTICODE_BLOCK_END -->
<!-- To DO: Add an example command to the assets/js/apitool-methods-ws.js file. The WebSocket Tool requires access to a publicly available Clio server.
[Try it! >](websocket-api-tool.html#nft_info)-->
The request contains the following parameters:
| `Field` | Type | Description |
|:---------------|:---------------------------|:-------------------------------|
| `nft_id` | String | A unique identifier for the non-fungible token (NFT). |
| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. If you do not specify this field, it defaults to `validated`. (See [Specifying Ledgers][]) |
| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. If you do not specify this field, it defaults to `validated`. Do not specify the `ledger_index` as `closed` or `current`; doing so forwards the request to the P2P `rippled` server and the `nft_info` API is not available on `rippled`. (See [Specifying Ledgers][]) |
## Response Format
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 1,
"result": {
"nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000",
"ledger_index": 270,
"owner": "rG9gdNygQ6npA9JvDFWBoeXbiUcTYJnEnk",
"is_burned": true,
"flags": 8,
"transfer_fee": 0,
"issuer": "rHVokeuSnjPjz718qdb47bGXBBHNMP3KDQ",
"nft_taxon": 0,
"nft_sequence": 0,
"validated": true
},
"status": "success",
"type": "response",
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include ledger_index:current in your request"
},
{
"id": 2002,
"message": "This server may be out of date"
}
]
}
```
*JSON-RPC*
```json
{
"result": {
"nft_id": "00080000B4F4AFC5FBCBD76873F18006173D2193467D3EE70000099B00000000",
"ledger_index": 269,
"owner": "rG9gdNygQ6npA9JvDFWBoeXbiUcTYJnEnk",
"is_burned": false,
"flags": 8,
"transfer_fee": 0,
"issuer": "rHVokeuSnjPjz718qdb47bGXBBHNMP3KDQ",
"nft_taxon": 0,
"nft_sequence": 0,
"uri": "https://xrpl.org",
"validated": true,
"status": "success"
},
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"
},
{
"id": 2002,
"message": "This server may be out of date"
}
]
}
```
<!-- MULTICODE_BLOCK_END -->
The response follows the [standard format][], with a successful result containing an `nft_info` response object with some arrangement of the following fields:
| `Field` | Type | Description |
|:----------------------------------|:----------------|:---------------------|
| `nft_id` | String | A unique identifier for the non-fungible token (NFT). |
| `ledger_index` | Integer | The [ledger index][] of the most recent ledger version where the state of this NFT was modified, as in the NFT was minted (created), changed ownership (traded), or burned (destroyed). The information returned contains whatever happened most recently compared to the requested ledger. |
| `owner` | String | The account ID of this NFT's owner at this ledger index. |
| `is_burned` | Boolean | Returns `true` if the NFT is burned at this ledger, or `false` otherwise. |
| `flags ` | Integer | The flag set of this NFT. |
| `transfer_fee` | Integer | The transfer fee of this NFT. See [NFTokenMint Fields](nftokenmint.html#nftokenmint-fields) for more information on transfer fees. |
| `issuer` | String | The account ID which denotes the issuer of this NFT. |
| `nft_taxon` | Integer | The NFT’s taxon. |
| `nft_sequence` | Integer | The NFT’s sequence number. |
| `uri` | String or `null` | _(Omitted if the NFT is burned at this ledger.)_. This field is `null` if the NFT is not burned at this ledger but does not have a URI. If the NFT is not burned at this ledger and it does have a URI, this field is a string containing the decoded URI of the NFT. NOTE: If you need to retrieve the URI of a burnt token, re-request `nft_info` for this token, specifying the `ledger_index` as the one previous to the index where this token was burned ({ledger_index-where-token-was-burned} - 1). |
## Possible Errors
* Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/rippled_versions.md' %}

539
content/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md Normal file
View File

@@ -0,0 +1,539 @@
---
html: server_info-clio.html
parent: clio-methods.html
blurb: Retrieve status of the Clio server in human-readable format.
labels:
- Core Server
---
# server_info
[[Source]](https://github.com/XRPLF/clio/blob/master/src/rpc/handlers/ServerInfo.cpp "Source")
The `server_info` command asks the [Clio server](the-clio-server.html) for a human-readable version of various information about the Clio server being queried. For `rippled` servers, see [`server_info` (`rippled`)](server_info.html) instead. [New in: Clio v1.0.0](https://github.com/XRPLF/clio/releases/tag/1.0.0 "BADGE_BLUE")
## Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 1,
"command": "server_info"
}
```
*JSON-RPC*
```json
{
"method": "server_info",
"params": [
{}
]
}
```
<!-- MULTICODE_BLOCK_END -->
<!-- [Try it! >](websocket-api-tool.html#server_info) -->
The request does not take any parameters.
## Response Format
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 1,
"result": {
"info": {
"complete_ledgers": "19499132-19977628",
"counters": {
"rpc": {
"account_objects": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "991"
},
"account_tx": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "91633"
},
"account_lines": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "0",
"duration_us": "4915159"
},
"submit_multisigned": {
"started": "2",
"finished": "2",
"errored": "0",
"forwarded": "2",
"duration_us": "4823"
},
"ledger_entry": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "17806"
},
"server_info": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "0",
"duration_us": "2375580"
},
"account_info": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "5",
"duration_us": "9256"
},
"account_currencies": {
"started": "4",
"finished": "4",
"errored": "0",
"forwarded": "0",
"duration_us": "517302"
},
"noripple_check": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "2218"
},
"tx": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "562"
},
"gateway_balances": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "0",
"duration_us": "1395156"
},
"channel_authorize": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "2017"
},
"manifest": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "1707"
},
"subscribe": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "0",
"duration_us": "116"
},
"random": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "111"
},
"ledger_data": {
"started": "14",
"finished": "3",
"errored": "11",
"forwarded": "0",
"duration_us": "6179145"
},
"ripple_path_find": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "1409563"
},
"account_channels": {
"started": "14",
"finished": "14",
"errored": "0",
"forwarded": "0",
"duration_us": "1062692"
},
"submit": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "6",
"duration_us": "11383"
},
"transaction_entry": {
"started": "8",
"finished": "5",
"errored": "3",
"forwarded": "0",
"duration_us": "494131"
}
},
"subscriptions": {
"ledger": 0,
"transactions": 0,
"transactions_proposed": 0,
"manifests": 2,
"validations": 2,
"account": 0,
"accounts_proposed": 0,
"books": 0
}
},
"load_factor": 1,
"clio_version": "0.3.0-b2",
"validation_quorum": 8,
"rippled_version": "1.9.1-rc1",
"validated_ledger": {
"age": 4,
"hash": "4CD25FB70D45646EE5822E76E58B66D39D5AE6BA0F70491FA803DA0DA218F434",
"seq": 19977628,
"base_fee_xrp": 1E-5,
"reserve_base_xrp": 1E1,
"reserve_inc_xrp": 2E0
}
},
"cache": {
"size": 8812733,
"is_full": true,
"latest_ledger_seq": 19977629
},
"etl": {
"etl_sources": [
{
"validated_range": "19405538-19977629",
"is_connected": "1",
"ip": "52.36.182.38",
"ws_port": "6005",
"grpc_port": "50051",
"last_msg_age_seconds": "0"
}
],
"is_writer": true,
"read_only": false,
"last_publish_age_seconds": "2"
},
"validated": true
},
"status": "success",
"type": "response",
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include ledger_index:current in your request"
},
{
"id": 2002,
"message": "This server may be out of date"
}
]
}
```
*JSON-RPC*
```json
200 OK
{
"result": {
"info": {
"complete_ledgers": "19499132-19977628",
"counters": {
"rpc": {
"account_objects": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "991"
},
"account_tx": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "91633"
},
"account_lines": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "0",
"duration_us": "4915159"
},
"submit_multisigned": {
"started": "2",
"finished": "2",
"errored": "0",
"forwarded": "2",
"duration_us": "4823"
},
"ledger_entry": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "17806"
},
"server_info": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "0",
"duration_us": "2375580"
},
"account_info": {
"started": "5",
"finished": "5",
"errored": "0",
"forwarded": "5",
"duration_us": "9256"
},
"account_currencies": {
"started": "4",
"finished": "4",
"errored": "0",
"forwarded": "0",
"duration_us": "517302"
},
"noripple_check": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "2218"
},
"tx": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "562"
},
"gateway_balances": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "0",
"duration_us": "1395156"
},
"channel_authorize": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "2017"
},
"manifest": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "1707"
},
"subscribe": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "0",
"duration_us": "116"
},
"random": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "0",
"duration_us": "111"
},
"ledger_data": {
"started": "14",
"finished": "3",
"errored": "11",
"forwarded": "0",
"duration_us": "6179145"
},
"ripple_path_find": {
"started": "1",
"finished": "1",
"errored": "0",
"forwarded": "1",
"duration_us": "1409563"
},
"account_channels": {
"started": "14",
"finished": "14",
"errored": "0",
"forwarded": "0",
"duration_us": "1062692"
},
"submit": {
"started": "6",
"finished": "6",
"errored": "0",
"forwarded": "6",
"duration_us": "11383"
},
"transaction_entry": {
"started": "8",
"finished": "5",
"errored": "3",
"forwarded": "0",
"duration_us": "494131"
}
},
"subscriptions": {
"ledger": 0,
"transactions": 0,
"transactions_proposed": 0,
"manifests": 2,
"validations": 2,
"account": 0,
"accounts_proposed": 0,
"books": 0
}
},
"load_factor": 1,
"clio_version": "0.3.0-b2",
"validation_quorum": 8,
"rippled_version": "1.9.1-rc1",
"validated_ledger": {
"age": 4,
"hash": "4CD25FB70D45646EE5822E76E58B66D39D5AE6BA0F70491FA803DA0DA218F434",
"seq": 19977628,
"base_fee_xrp": 1E-5,
"reserve_base_xrp": 1E1,
"reserve_inc_xrp": 2E0
}
},
"cache": {
"size": 8812733,
"is_full": true,
"latest_ledger_seq": 19977629
},
"etl": {
"etl_sources": [
{
"validated_range": "19405538-19977629",
"is_connected": "1",
"ip": "52.36.182.38",
"ws_port": "6005",
"grpc_port": "50051",
"last_msg_age_seconds": "0"
}
],
"is_writer": true,
"read_only": false,
"last_publish_age_seconds": "2"
},
"validated": true,
},
"status": "success",
"type": "response",
"warnings": [
{
"id": 2001,
"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include ledger_index:current in your request"
},
{
"id": 2002,
"message": "This server may be out of date"
}
]
}
```
<!-- MULTICODE_BLOCK_END -->
The response follows the [standard format][], with a successful result containing an `info` object as its only field.
The `info` object may have some arrangement of the following fields:
| `Field` | Type | Description |
|:------------------------------------|:----------------|:---------------------|
| `complete_ledgers` | String | Range expression indicating the sequence numbers of the ledger versions the local `rippled` has in its database. This may be a disjoint sequence such as `24900901-24900984,24901116-24901158`. If the server does not have any complete ledgers (for example, it recently started syncing with the network), this is the string `empty`. |
| `rpc` | Object array | Stats on each RPC handled by the Clip server since startup. |
| `rpc.*.started` | Number | Number of RPCs of this type that the Clio server has started processing since startup. |
| `rpc.*.finished` | Number | Number of RPCs of this type that the Clio server has finished processing since startup. |
| `rpc.*.errored` | Number | Number of RPCs of this type that have resulted in some sort of error since startup. |
| `rpc.*.forwarded` | Number | Number of RPCs of this type that the Clio server has forwarded to a `rippled` P2P server since startup. |
| `rpc.*.duration_us` | Number | The total number of microseconds spent processing RPCs of this type since startup. |
| `subscriptions` | Object | Number of current subscribers for each stream type. |
| `subscriptions.ledger` | | |
| `subscriptions.transactions` | | |
| `subscriptions.transactions_proposed` | | |
| `subscriptions.manifests` | | |
| `subscriptions.validations` | | |
| `subscriptions.account` | | |
| `subscriptions.accounts_proposed` | | |
| `subscriptions.books` | | |
| `load_factor` | Number | The load-scaled open ledger transaction cost the server is currently enforcing, as a multiplier on the base transaction cost. For example, at `1000` load factor and a reference transaction cost of 10 drops of XRP, the load-scaled transaction cost is 10,000 drops (0.01 XRP). The load factor is determined by the highest of the [individual server's load factor](transaction-cost.html#local-load-cost), the cluster's load factor, the [open ledger cost](transaction-cost.html#open-ledger-cost) and the overall network's load factor. [Updated in: rippled 0.33.0][] |
| `clio_version` | String | The version number of the running `Clio` server. |
| `validation_quorum` | Number | Minimum number of trusted validations required to validate a ledger version. Some circumstances may cause the server to require more validations. This value is obtained from `rippled`. |
| `rippled_version` | String | The version number of the running `rippled` server that the `Clio` server is connected to. |
| `validated_ledger` | Object | _(May be omitted)_ Information about the most recent fully-validated ledger. If the most recent validated ledger is not available, the response omits this field and includes `closed_ledger` instead. |
| `validated_ledger.age` | Number | The time since the ledger was closed, in seconds. |
| `validated_ledger.base_fee_xrp` | Number | Base fee, in XRP. This may be represented in scientific notation such as `1e-05` for 0.00001. |
| `validated_ledger.hash` | String | Unique hash for the ledger, as hexadecimal. |
| `validated_ledger.reserve_base_xrp` | Number | Minimum amount of XRP (not drops) necessary for every account to keep in reserve |
| `validated_ledger.reserve_inc_xrp` | Number | Amount of XRP (not drops) added to the account reserve for each object an account owns in the ledger. |
| `validated_ledger.seq` | Number | The [ledger index][] of the latest validated ledger. |
| `validator_list_expires` | String | _(Admin only)_ Either the human readable time, in UTC, when the current validator list will expire, the string `unknown` if the server has yet to load a published validator list or the string `never` if the server uses a static validator list. [Updated in: rippled 1.5.0][] |
| `cache` | Object | Information on Clio's state data cache. |
| `cache.size` | Number | Number of state data objects currently in the cache. |
| `cache.is_full` | Boolean | True if cache contains all state data for a specific ledger, false otherwise. Some RPCs, such as book_offers, process much faster when the cache is full. |
| `cache.latest_ledger_seq` | Number | The [ledger index][] of the latest validated ledger stored in the cache. |
| `etl` | Object | The `rippled` sources (ETL sources) that the Clio server is connected to. |
| `etl.etl_sources` | Object Array | List the `rippled` sources (ETL sources) that the Clio server is connected to and extracts data from. |
| `etl.etl_sources.validated_range` | String | The validated ledger range retrieved by the P2P `rippled` server. |
| `etl.etl_sources.is_connected` | Boolean | True if Clio is connected to this source via websocket, false otherwise. A value of false here could indicate a networking issue, or that `rippled` is not running, amongst other things. |
| `etl.etl_sources.ip` | Number | IP of the `rippled` server. |
| `etl.etl_sources.ws_port` | Number | Websocket port of the `rippled` server. |
| `etl.etl_sources.grpc_port` | Number | The gRPC connection port of the P2P `rippled` server that the Clio server is connected to. |
| `etl.etl_sources.last_msg_age_seconds` | Number | Total seconds that have elapsed since Clio last heard anything from `rippled`. This should not be higher than 8. |
| `etl.is_writer` | Boolean | True if this Clio server is currently writing data to the database, false otherwise. |
| `etl.read_only` | Boolean | True if this Clio server is configured in read-only mode, false otherwise. |
| `etl.last_publish_age_seconds` | Number | Time in seconds that have elapsed since this Clio server last published a ledger. This should not be more than 8. |
| `validated` | Boolean | When true, this indicates that the response uses a ledger version that has been validated by consensus. In Clio, this is always true as Clio stores and returns validated ledger data. If a request was forwarded to `rippled` and the server returns current data, a missing or false value indicates that this ledger's data is not final. |
| `status` | String | Returns the status of the API request: `success` when the request completes successfully. |
## Possible Errors
* Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

8
content/references/http-websocket-apis/public-api-methods/public-api-methods.md
View File

@@ -92,6 +92,14 @@ Use these methods to retrieve information about the current state of the `ripple
* **[`server_state`](server_state.html)** - Retrieve status of the server in machine-readable format.
- **[`manifest`](manifest.html)** - Retrieve the latest ephemeral public key information about a known validator.
## [Clio Methods](clio-methods.html)
Use these methods to retrieve information using Clio server APIs.
* **[`server_info`](server_info-clio.html)** - Retrieve status of the Clio server.
* **[`ledger`](ledger-clio.html)** - Get info about a ledger version using Clio server's `ledger` API.
* **[`nft_info`](nft_info.html)** - Retrieve information about the specified NFT using Clio server's `nft_info` API.
## [Utility Methods](utility-methods.html)
Use these methods to perform convenient tasks, such as ping and random number generation.

306
content/references/http-websocket-apis/public-api-methods/server-info-methods/server_info-clio.md
View File

@@ -1,306 +0,0 @@
---
html: server_info-clio.html
parent: server-info-methods.html
blurb: Retrieve status of the Clio server in human-readable format.
labels:
- Core Server
---
# server_info (Clio)
[[Source]](https://github.com/XRPLF/clio/blob/master/src/rpc/handlers/ServerInfo.cpp "Source")
The `server_info` command asks the [Clio server](the-clio-server.html) for a human-readable version of various information about the Clio server being queried. For `rippled` servers, see [`server_info` (`rippled`)](server_info.html) instead.
## Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 1,
"command": "server_info"
}
```
*JSON-RPC*
```json
{
"method": "server_info",
"params": [
{}
]
}
```
*Commandline*
```sh
#Syntax: server_info
rippled server_info
```
<!-- MULTICODE_BLOCK_END -->
[Try it! >](websocket-api-tool.html#server_info)
The request does not take any parameters.
## Response Format
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
```json
{
"id": 1,
"result": {
"info": {
"build_version": "1.7.2",
"complete_ledgers": "64572720-65887227",
"hostid": "LARD",
"io_latency_ms": 1,
"jq_trans_overflow": "0",
"last_close": {
"converge_time_s": 3.004,
"proposers": 41
},
"load_factor": 512.578125,
"load_factor_server": 1,
"peer_disconnects": "365016",
"peer_disconnects_resources": "336",
"peers": 211,
"pubkey_node": "n9MozjnGB3tpULewtTsVtuudg5JqYFyV3QFdAtVLzJaxHcBaxuXD",
"server_state": "full",
"server_state_duration_us": "3589068181859",
"state_accounting": {
"connected": {
"duration_us": "301410595",
"transitions": 2
},
"disconnected": {
"duration_us": "1207534",
"transitions": 2
},
"full": {
"duration_us": "3589270527034",
"transitions": 2
},
"syncing": {
"duration_us": "6182323",
"transitions": 2
},
"tracking": {
"duration_us": "43",
"transitions": 2
}
},
"time": "2021-Aug-24 20:46:22.194299 UTC",
"uptime": 3589579,
"validated_ledger": {
"age": 3,
"base_fee_xrp": 0.00001,
"hash": "F00F0E590242702B895BE378B6A6D365C094A047CFC8B11DD323D16F81CC67A5",
"reserve_base_xrp": 20,
"reserve_inc_xrp": 5,
"seq": 65887227
},
"validation_quorum": 33
}
},
"status": "success",
"type": "response"
}
```
*JSON-RPC*
```json
200 OK
{
"result": {
"info": {
"build_version": "1.7.2",
"complete_ledgers": "64735538-65886965",
"hostid": "TOLL",
"io_latency_ms": 1,
"jq_trans_overflow": "3",
"last_close": {
"converge_time_s": 3,
"proposers": 41
},
"load_factor": 1,
"peer_disconnects": "467400",
"peer_disconnects_resources": "16316",
"peers": 85,
"pubkey_node": "n9Mdk7abYaVvded5zic9oDEY3NULv9RmeJ9Z5hgjXX1ycZqAGhTn",
"server_state": "full",
"server_state_duration_us": "627203282776",
"state_accounting": {
"connected": {
"duration_us": "600242389",
"transitions": 40
},
"disconnected": {
"duration_us": "112927",
"transitions": 1
},
"full": {
"duration_us": "3591757226163",
"transitions": 46
},
"syncing": {
"duration_us": "5304456",
"transitions": 7
},
"tracking": {
"duration_us": "13989631",
"transitions": 46
}
},
"time": "2021-Aug-24 20:29:53.291350 UTC",
"uptime": 3592376,
"validated_ledger": {
"age": 2,
"base_fee_xrp": 0.00001,
"hash": "B79D223A27F4EC214C9BA85665B12EE76C1EE2CB887BBCBAFB6484355C43FEFA",
"reserve_base_xrp": 20,
"reserve_inc_xrp": 5,
"seq": 65886965
},
"validation_quorum": 33
},
"status": "success"
}
}
```
*Commandline*
```json
Loading: "/etc/opt/ripple/rippled.cfg"
2020-Mar-24 01:28:22.288484766 UTC HTTPClient:NFO Connecting to 127.0.0.1:5005
{
"result": {
"info": {
"build_version": "1.7.2",
"complete_ledgers": "64735538-65886965",
"hostid": "TOLL",
"io_latency_ms": 1,
"jq_trans_overflow": "3",
"last_close": {
"converge_time_s": 3,
"proposers": 41
},
"load_factor": 1,
"peer_disconnects": "467400",
"peer_disconnects_resources": "16316",
"peers": 85,
"pubkey_node": "n9Mdk7abYaVvded5zic9oDEY3NULv9RmeJ9Z5hgjXX1ycZqAGhTn",
"server_state": "full",
"server_state_duration_us": "627203282776",
"state_accounting": {
"connected": {
"duration_us": "600242389",
"transitions": 40
},
"disconnected": {
"duration_us": "112927",
"transitions": 1
},
"full": {
"duration_us": "3591757226163",
"transitions": 46
},
"syncing": {
"duration_us": "5304456",
"transitions": 7
},
"tracking": {
"duration_us": "13989631",
"transitions": 46
}
},
"time": "2021-Aug-24 20:29:53.291350 UTC",
"uptime": 3592376,
"validated_ledger": {
"age": 2,
"base_fee_xrp": 0.00001,
"hash": "B79D223A27F4EC214C9BA85665B12EE76C1EE2CB887BBCBAFB6484355C43FEFA",
"reserve_base_xrp": 20,
"reserve_inc_xrp": 5,
"seq": 65886965
},
"validation_quorum": 33
},
"status": "success"
}
}
```
<!-- MULTICODE_BLOCK_END -->
The response follows the [standard format][], with a successful result containing an `info` object as its only field.
The `info` object may have some arrangement of the following fields:
| `Field` | Type | Description |
|:------------------------------------|:----------------|:---------------------|
| `amendment_blocked` | Boolean | _(May be omitted)_ If `true`, this server is [amendment blocked](amendments.html#amendment-blocked). If the server is not amendment blocked, the response omits this field. [New in: rippled 0.80.0][] |
| `build_version` | String | The version number of the running `rippled` version. |
| `closed_ledger` | Object | _(May be omitted)_ Information on the most recently closed ledger that has not been validated by consensus. If the most recently validated ledger is available, the response omits this field and includes `validated_ledger` instead. The member fields are the same as the `validated_ledger` field. |
| `complete_ledgers` | String | Range expression indicating the sequence numbers of the ledger versions the local `rippled` has in its database. This may be a disjoint sequence such as `24900901-24900984,24901116-24901158`. If the server does not have any complete ledgers (for example, it recently started syncing with the network), this is the string `empty`. |
| `hostid` | String | On an admin request, returns the hostname of the server running the `rippled` instance; otherwise, returns a single [RFC-1751][] word based on the [node public key](peer-protocol.html#node-key-pair). |
| `io_latency_ms` | Number | Amount of time spent waiting for I/O operations, in milliseconds. If this number is not very, very low, then the `rippled` server is probably having serious load issues. |
| `jq_trans_overflow` | String - Number | The number of times (since starting up) that this server has had over 250 transactions waiting to be processed at once. A large number here may mean that your server is unable to handle the transaction load of the XRP Ledger network. For detailed recommendations of future-proof server specifications, see [Capacity Planning](capacity-planning.html). [New in: rippled 0.90.0][] |
| `last_close` | Object | Information about the last time the server closed a ledger, including the amount of time it took to reach a consensus and the number of trusted validators participating. |
| `last_close.converge_time_s` | Number | The amount of time it took to reach a consensus on the most recently validated ledger version, in seconds. |
| `last_close.proposers` | Number | How many trusted validators the server considered (including itself, if configured as a validator) in the consensus process for the most recently validated ledger version. |
| `load` | Object | _(Admin only)_ Detailed information about the current load state of the server. |
| `load.job_types` | Array | _(Admin only)_ Information about the rate of different types of jobs the server is doing and how much time it spends on each. |
| `load.threads` | Number | _(Admin only)_ The number of threads in the server's main job pool. |
| `load_factor` | Number | The load-scaled open ledger transaction cost the server is currently enforcing, as a multiplier on the base transaction cost. For example, at `1000` load factor and a reference transaction cost of 10 drops of XRP, the load-scaled transaction cost is 10,000 drops (0.01 XRP). The load factor is determined by the highest of the [individual server's load factor](transaction-cost.html#local-load-cost), the cluster's load factor, the [open ledger cost](transaction-cost.html#open-ledger-cost) and the overall network's load factor. [Updated in: rippled 0.33.0][] |
| `load_factor_local` | Number | _(May be omitted)_ Current multiplier to the [transaction cost][] based on load to this server. |
| `load_factor_net` | Number | _(May be omitted)_ Current multiplier to the [transaction cost][] being used by the rest of the network (estimated from other servers' reported load values). |
| `load_factor_cluster` | Number | _(May be omitted)_ Current multiplier to the [transaction cost][] based on load to servers in [this cluster](clustering.html). |
| `load_factor_fee_escalation` | Number | _(May be omitted)_ The current multiplier to the [transaction cost][] that a transaction must pay to get into the open ledger. [New in: rippled 0.32.0][] |
| `load_factor_fee_queue` | Number | _(May be omitted)_ The current multiplier to the [transaction cost][] that a transaction must pay to get into the queue, if the queue is full. [New in: rippled 0.32.0][] |
| `load_factor_server` | Number | _(May be omitted)_ The load factor the server is enforcing, not including the [open ledger cost](transaction-cost.html#open-ledger-cost). [New in: rippled 0.33.0][] |
| `peers` | Number | How many other `rippled` servers this one is currently connected to. |
| `pubkey_node` | String | Public key used to verify this server for peer-to-peer communications. This [_node key pair_](peer-protocol.html#node-key-pair) is automatically generated by the server the first time it starts up. (If deleted, the server can create a new pair of keys.) You can set a persistent value in the config file using the `[node_seed]` config option, which is useful for [clustering](clustering.html). |
| `pubkey_validator` | String | _(Admin only)_ Public key used by this node to sign ledger validations. This _validation key pair_ is derived from the `[validator_token]` or `[validation_seed]` config field. |
| `server_state` | String | A string indicating to what extent the server is participating in the network. See [Possible Server States](rippled-server-states.html) for more details. |
| `server_state_duration_us` | Number | The number of consecutive microseconds the server has been in the current state. [New in: rippled 1.2.0][] |
| `state_accounting` | Object | A map of various [server states](rippled-server-states.html) with information about the time the server spends in each. This can be useful for tracking the long-term health of your server's connectivity to the network. [New in: rippled 0.30.1][] |
| `state_accounting.*.duration_us` | String | The number of microseconds the server has spent in this state. (This is updated whenever the server transitions into another state.) [New in: rippled 0.30.1][] |
| `state_accounting.*.transitions` | Number | The number of times the server has changed into this state. [New in: rippled 0.30.1][] |
| `time` | String | The current time in UTC, according to the server's clock. [Updated in: rippled 1.5.0][] |
| `uptime` | Number | Number of consecutive seconds that the server has been operational. [New in: rippled 0.30.1][] |
| `validated_ledger` | Object | _(May be omitted)_ Information about the most recent fully-validated ledger. If the most recent validated ledger is not available, the response omits this field and includes `closed_ledger` instead. |
| `validated_ledger.age` | Number | The time since the ledger was closed, in seconds. |
| `validated_ledger.base_fee_xrp` | Number | Base fee, in XRP. This may be represented in scientific notation such as `1e-05` for 0.00001. |
| `validated_ledger.hash` | String | Unique hash for the ledger, as hexadecimal. |
| `validated_ledger.reserve_base_xrp` | Number | Minimum amount of XRP (not drops) necessary for every account to keep in reserve |
| `validated_ledger.reserve_inc_xrp` | Number | Amount of XRP (not drops) added to the account reserve for each object an account owns in the ledger. |
| `validated_ledger.seq` | Number | The [ledger index][] of the latest validated ledger. |
| `validation_quorum` | Number | Minimum number of trusted validations required to validate a ledger version. Some circumstances may cause the server to require more validations. |
| `validator_list_expires` | String | _(Admin only)_ Either the human readable time, in UTC, when the current validator list will expire, the string `unknown` if the server has yet to load a published validator list or the string `never` if the server uses a static validator list. [Updated in: rippled 1.5.0][] |
**Note:** If the `closed_ledger` field is present and has a small `seq` value (less than 8 digits), that indicates `rippled` does not currently have a copy of the validated ledger from the peer-to-peer network. This could mean your server is still syncing. Typically, it takes about 5 minutes to sync with the network, depending on your connection speed and hardware specs.
## Possible Errors
* Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

2
content/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md
View File

@@ -254,7 +254,7 @@ The `info` object may have some arrangement of the following fields:
| `Field` | Type | Description |
|:------------------------------------|:----------------|:---------------------|
| `amendment_blocked` | Boolean | _(May be omitted)_ If `true`, this server is [amendment blocked](amendments.html#amendment-blocked). If the server is not amendment blocked, the response omits this field. [New in: rippled 0.80.0][] |
| `build_version` | String | The version number of the running `rippled` version. |
| `build_version` | String | The version number of the running `rippled` server. |
| `closed_ledger` | Object | _(May be omitted)_ Information on the most recently closed ledger that has not been validated by consensus. If the most recently validated ledger is available, the response omits this field and includes `validated_ledger` instead. The member fields are the same as the `validated_ledger` field. |
| `complete_ledgers` | String | Range expression indicating the sequence numbers of the ledger versions the local `rippled` has in its database. This may be a disjoint sequence such as `24900901-24900984,24901116-24901158`. If the server does not have any complete ledgers (for example, it recently started syncing with the network), this is the string `empty`. |
| `hostid` | String | On an admin request, returns the hostname of the server running the `rippled` instance; otherwise, returns a single [RFC-1751][] word based on the [node public key](peer-protocol.html#node-key-pair). |