server_info
The server_info command asks the Clio server for a human-readable version of various information about the Clio server being queried.
Request Format
An example of the request format:
curl --location 'https://xrp.nownodes.io' \
--header 'Content-Type: application/json' \
--header 'api-key: 'API_KEY' \
--data '{
"method": "server_info",
"params": [
{}
]
}'The request does not take any parameters.
Response Format
When a client connects to the Clio server over localhost, the response includes the counters and etl objects. These objects are omitted from the response when the client is not located on the same server, and hence does not connect over localhost.
An example of a successful response when client connects over localhost:
{
"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"
}
]
}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"
}
]
}An example of a successful response when client does not connect over localhost:
{
"id": 1,
"result": {
"info": {
"complete_ledgers":"32570-73737719",
"load_factor":1,
"clio_version":"1.0.2",
"validation_quorum":28,
"rippled_version":"1.9.1",
"validated_ledger": {
"age":7,
"hash":"4ECDEAF9E6F8B37EFDE297953168AAB42DEED1082A565639EBB2D29E047341B4",
"seq":73737719,
"base_fee_xrp":1E-5,
"reserve_base_xrp":1E1,
"reserve_inc_xrp":2E0
},
"cache": {
"size":15258947,
"is_full":true,
"latest_ledger_seq":73737719
}
},
"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"
}
]
}200 OK
{
"result": {
"info": {
"complete_ledgers":"32570-73737719",
"load_factor":1,
"clio_version":"1.0.2",
"validation_quorum":28,
"rippled_version":"1.9.1",
"validated_ledger": {
"age":7,
"hash":"4ECDEAF9E6F8B37EFDE297953168AAB42DEED1082A565639EBB2D29E047341B4",
"seq":73737719,
"base_fee_xrp":1E-5,
"reserve_base_xrp":1E1,
"reserve_inc_xrp":2E0
},
"cache": {
"size":15258947,
"is_full":true,
"latest_ledger_seq":73737719
}
},
"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"
}
]
}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.
counters
Object
(May be omitted) Stats on API calls handled since server startup. This is present only if the client connects to the Clio server over localhost.
rpc
Object
(May be omitted) Stats on each API call handled by the Clio server since startup. Since this is nested within the counters object, this is also present only if the client connects to the Clio server over localhost.
rpc.*.started
Number
Number of API calls of this type that the Clio server has started processing since startup.
rpc.*.finished
Number
Number of API calls of this type that the Clio server has finished processing since startup.
rpc.*.errored
Number
Number of API calls of this type that have resulted in some sort of error since startup.
rpc.*.forwarded
Number
Number of API calls 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 API calls of this type since startup.
subscriptions
Object
(May be omitted) Number of current subscribers for each stream type. Since this is nested within the counters object, this is also present only if the client connects to the Clio server over localhost.
subscriptions.ledger
subscriptions.transactions
subscriptions.transactions_proposed
subscriptions.manifests
subscriptions.validations
subscriptions.account
subscriptions.accounts_proposed
subscriptions.books
time
String
The current time in UTC, according to the server's clock.
Possible Errors
Any of the [universal error types][].
Last updated