API Documentation
API Reference
/api/check_historic_node
Checks the status of a node based on the last crawl<br>
result see /api/check_historical_node
Arguments:
- node: connection string, e.g. grs:127.0.0.1:1331 - port is optional if it is the network default
Returns: json dict {"result":{"user_agent":"/Groestlcoin:2.17.2/", "version":" .... }}
/api/check_node
Checks the current status of a node. This is a live result, so response times will be longer - to view a saved<br>
result see /api/check_historic_node.
Arguments:
- node: connection string, e.g. grs:127.0.0.1:1331 - port is optional if it is the network default
- to_services (integer, optional): outgoing services to broadcast, default=0
- from_services (integer, optional): outgoing services to broadcast, default=0
- version (integer, optional): version code to broadcast, default varies by network
- user_agent (string, optional): user agent to broadcast, default="/groestl-nodes:0.1/"
- height (integer, optional): block height to broadcast during handshake. default=network median
- p2p_nodes (bool, optional): issues a getaddr call and list of connected nodes, default=False
Returns: json dict {"result":{"user_agent":"/Groestlcoin:2.17.2/", "version":" .... }, "nodes":[["127.0.0.1:1331, 157532132191], ...]}
/api/get_networks
Returns a list of all available network names
Returns: JSON string, ex. "['groestlcoin','testnet']"
/api/get_nodes
Gets a list of all nodes visible during the past 30 days
Arguments:
- network (optional): Filters the result set based on the given network
Returns: json array [{"address":"127.0.0.1" ... }, {"address":"0.0.0.0", "port:1331}]
/api/gzip_file/<filename>
Returns a crawl result as a gzipped response
Arguments:
- filename: file_network.ext - file is 'data' or 'history', ext is either .json, .csv, .txt (data.ext returns data for all crawled networks)
Returns: gzip encoded html response
/api/node_history
Returns the data associated with a node, and all crawler visitations on record
Arguments:
- node: connection string, e.g. grs:127.0.0.1:1331 - port is optional if it is the network default.
Returns: json dict {"node":{"user_agent":"/Groestlcoin/", "last_seen": ... }, "history":{"timestamp":157032190321,"height":56000, "success":1 ...}}