[FEATURE] Charts API Tool

This commit is contained in:
mDuo13
2015-04-02 14:49:21 -07:00
parent d74ab3c3f1
commit aff130c95e
17 changed files with 473 additions and 0 deletions

191
charts-api-tool.html Normal file
View File

@@ -0,0 +1,191 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width">
<title>Charts API Tool - Ripple Developer Portal</title>
<!-- favicon -->
<link rel="icon" href="favicon.ico" type="image/x-icon">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<!-- jQuery -->
<script src="vendor/jquery-1.11.1.min.js"></script>
<!-- Bootstrap -->
<link href="css/bootstrap.min.css" rel="stylesheet">
<script src="js/bootstrap.min.js"></script>
<!-- Custom Stylesheets -->
<link href="font/fonts.css" rel="stylesheet" type="text/css" />
<link href="css/main.css" rel="stylesheet" />
<link href="css/custom.css" rel="stylesheet" />
<link rel="shortcut icon" href="favicon.ico?v=2" type="image/x-icon" />
<link rel="icon" href="favicon.ico?v=2" type="image/x-icon" />
</head>
<body >
<div class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="./"><img class="small_logo" src="assets/img/ripple_logo_small.png"></a>
</div>
<div class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="./" class="dropdown-toggle" data-toggle="dropdown">Documentation <span class="caret"></span></a>
<ul class="dropdown-menu" role="menu">
<li><a href="rippled-apis.html">rippled</a></li>
<li><a href="ripple-rest.html">Ripple-REST</a></li>
<li><a href="gatewayd.html">Gatewayd</a></li>
<li><a href="transactions.html">Transactions</a></li>
<li><a href="reliable_tx.html">Reliable Transaction Submission</a></li>
<li><a href="gateway_guide.html">Gateway Guide</a></li>
<li><a href="historical_data.html">Historical Data API</a></li>
<li><a href="charts_api.html">Ripple Charts API</a></li>
<li><a href="gateway_services.html">Gateway Services</a></li>
<li><a href="whitepapers.html">Whitepapers</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">API Tools <span class="caret"></span></a>
<ul class="dropdown-menu" role="menu">
<li><a href="rest-api-tool.html">Ripple-REST API Tool</a></li>
<li><a href="historicaldb-api-tool.html">Historical Database API Tool</a></li>
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
<li><a href="charts-api-tool.html">Charts API Tool</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <span class="caret"></span></a>
<ul class="dropdown-menu" role="menu">
<li><a href="https://forum.ripple.com/viewforum.php?f=2">Forums</a></li>
<li><a href="https://www.bountysource.com/teams/ripple/bounties">Bounties</a></li>
<li><a href="https://ripplelabs.atlassian.net/">Bug Tracking</a></li>
<li><a href="https://ripple.com/category/dev-blog/">Dev Blog</a></li>
<li><a href="https://ripple.com/press-releases/">Press Center</a></li>
<li><a href="https://ripple.com/brand-guidelines/">Brand Guidelines</a></li>
</ul>
<li><a href="https://github.com/ripple/ripple-dev-portal" title="GitHub">Site Source</a></li>
</ul>
</div><!--/.nav-collapse -->
</div>
</div>
<div class='wrapper'>
<div class='content-root'>
<div id='wrapper'>
<div style="clear:both;"></div>
<div id='command_wrapper'>
<ul id='command_list'>
</ul>
<div id='command_table'>
<div id='io_wrapper'>
<div id='input' class='io'>
<h2>REST Request</h2>
<div id='test_warning' class='alert alert-danger' style='display:none;'>
<h4>Test accounts only!</h4>
<p>Never submit account secrets to a server you do not control, unless you are prepared to lose ownership of the account!</p>
</div>
<div style="clear:both;"></div>
<h3 id='selected_command' title='Reference information'></h3>
<p id='description'></p>
<div id='invalid'>Invalid JSON</div>
<div id='rest_url_wrapper'>
<p><span id='rest_host'>https://api.ripplecharts.com</span><span id='rest_url'></span></p>
</div>
<div id='request_body'></div>
<div id='request_options'>
<div class="button btn btn-primary api" id='request_button'>Send request</div>
</div>
</div>
<div id='output' class='io'>
<h2>Response</h2>
<div>
<img class="loader" src="assets/img/rippleThrobber.png" style="vertical-align: middle; display:none;"/>
<span id='rest_responsecode'></span>
</div>
<div id='response_body'></div>
<div id='tooltip'></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<div class="row">
<div class="col-md-3">
<h4>Documentation</h4>
<ul class="footer_links">
<li><a href="rippled-apis.html">rippled</a></li>
<li><a href="ripple-rest.html">Ripple-REST</a></li>
<li><a href="gatewayd.html">Gatewayd</a></li>
<li><a href="transactions.html">Transactions</a></li>
<li><a href="reliable_tx.html">Reliable Transaction Submission</a></li>
<li><a href="gateway_guide.html">Gateway Guide</a></li>
<li><a href="historical_data.html">Historical Data API</a></li>
<li><a href="charts_api.html">Ripple Charts API</a></li>
<li><a href="gateway_services.html">Gateway Services</a></li>
<li><a href="whitepapers.html">Whitepapers</a></li>
</ul>
</div>
<div class="col-md-3">
<h4>Resources</h4>
<ul class="footer_links">
<li><a href="https://ripple.com/press-releases/">Press Center</a></li>
<li><a href="https://ripple.com/brand-guidelines/">Brand Use and Guidelines</a></li>
<li><a href="https://forum.ripple.com/viewforum.php?f=2">Forums</a></li>
<li><a href="https://ripple.com/category/dev-blog/">Dev Blog</a></li>
</ul>
</div>
<div class="col-md-3">
<h4>Ripple Projects</h4>
<ul class="footer_links">
<li><a href="https://www.rippletrade.com">Ripple Trade</a>
<li><a href="https://www.ripplecharts.com">Ripple Charts</a>
<li><a href="https://ripple.com/graph">Ripple Graph</a>
<li><a href="http://codius.org/">Codius</a>
</ul>
</div>
<div class="col-md-3">
<h4>Ripple Labs</h4>
<ul class="footer_links">
<li><a href="https://www.ripplelabs.com/wp-content/uploads/2014/10/ripple_labs_bylaws.pdf">Corporate Bylaws</a></li>
<li><a href="https://www.ripplelabs.com/wp-content/uploads/2014/09/ripple_labs_code_of_conduct1.pdf">Code of Conduct</a></li>
<li><a href="https://www.ripplelabs.com/team/">Team</a></li>
<li><a href="https://www.ripplelabs.com/careers/">Careers</a></li>
<li><a href="https://www.ripplelabs.com/investors/">Investors</a></li>
<li><a href="https://www.ripplelabs.com/advisors/">Advisors</a></li>
<li><a href="https://www.ripplelabs.com/xrp-distribution/">XRP Distribution</a></li>
<li><a href="https://www.ripplelabs.com/contact/">Contact</a></li>
</ul>
</div>
</div>
</div>
</footer>
<link rel='stylesheet' type='text/css' href='css/api-style.css'/>
<link rel='stylesheet' type='text/css' href='css/codemirror.css'/>
<script type='text/javascript' src='js/es5-shim.js'></script>
<script src='vendor/codemirror.min.js'></script>
<script type='text/javascript' src='js/cm-javascript.min.js'></script>
<script type='text/javascript' src='js/jquery.autosize.input.min.js'></script>
<script type='text/javascript' src='js/apitool-rest.js'></script>
<script type='text/javascript' src='js/apitool-methods-charts.js'></script>
</body>
</html>

View File

@@ -92,6 +92,7 @@
<li><a href="rest-api-tool.html">Ripple-REST API Tool</a></li>
<li><a href="historicaldb-api-tool.html">Historical Database API Tool</a></li>
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
<li><a href="charts-api-tool.html">Charts API Tool</a></li>
</ul>
</li>
<li class="dropdown">

View File

@@ -92,6 +92,7 @@
<li><a href="rest-api-tool.html">Ripple-REST API Tool</a></li>
<li><a href="historicaldb-api-tool.html">Historical Database API Tool</a></li>
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
<li><a href="charts-api-tool.html">Charts API Tool</a></li>
</ul>
</li>
<li class="dropdown">

View File

@@ -92,6 +92,7 @@
<li><a href="rest-api-tool.html">Ripple-REST API Tool</a></li>
<li><a href="historicaldb-api-tool.html">Historical Database API Tool</a></li>
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
<li><a href="charts-api-tool.html">Charts API Tool</a></li>
</ul>
</li>
<li class="dropdown">

View File

@@ -92,6 +92,7 @@
<li><a href="rest-api-tool.html">Ripple-REST API Tool</a></li>
<li><a href="historicaldb-api-tool.html">Historical Database API Tool</a></li>
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
<li><a href="charts-api-tool.html">Charts API Tool</a></li>
</ul>
</li>
<li class="dropdown">

View File

@@ -92,6 +92,7 @@
<li><a href="rest-api-tool.html">Ripple-REST API Tool</a></li>
<li><a href="historicaldb-api-tool.html">Historical Database API Tool</a></li>
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
<li><a href="charts-api-tool.html">Charts API Tool</a></li>
</ul>
</li>
<li class="dropdown">

View File

@@ -65,6 +65,7 @@
<li><a href="rest-api-tool.html">Ripple-REST API Tool</a></li>
<li><a href="historicaldb-api-tool.html">Historical Database API Tool</a></li>
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
<li><a href="charts-api-tool.html">Charts API Tool</a></li>
</ul>
</li>
<li class="dropdown">

View File

@@ -78,6 +78,7 @@
<li><a href="rest-api-tool.html">Ripple-REST API Tool</a></li>
<li><a href="historicaldb-api-tool.html">Historical Database API Tool</a></li>
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
<li><a href="charts-api-tool.html">Charts API Tool</a></li>
</ul>
</li>
<li class="dropdown">

View File

@@ -0,0 +1,260 @@
//---------- List of requests ------------------------//
// Must be loaded after apitool-rest.js //
var DOC_BASE = "charts_api.html";
var URL_BASE = "https://api.ripplecharts.com:443";
var DEFAULT_ADDRESS_1 = "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn";
var DEFAULT_HASH = "9D591B18EDDD34F0B6CF4223A2940AEA2C3CC778925BABF289E0011CD8FA056E";
var DEFAULT_LEDGER = "3170DA37CE2B7F045F889594CBC323D88686D2E90E8FFD2BBCD9BAD12E416DB5";
Request('Account Offers Exercised', {
method: POST,
path: "/api/account_offers_exercised",
description: "Retrieve currency-exchange orders being exercised for a single account.",
link: "#account-offers-exercised",
params: {},
body: {
account: DEFAULT_ADDRESS_1,
startTime: "2014",
limit: 5,
offset: 0,
format: "json"
}
});
Request('Accounts Created', {
method: POST,
path: "/api/accounts_created",
description: "Retrieve information about the creation of new Ripple accounts.",
link: "#accounts-created",
params: {},
body: {
"startTime": "2014-01-01",
"endTime": "2015-03-31",
"timeIncrement": "month",
"descending": true,
"reduce": true,
"format": "json"
}
});
Request('Exchange Rates', {
method: POST,
path: "/api/exchange_rates",
description: "Retrieve information about the exchange rates between one or more pairs of currency.",
link: "#exchange-rates",
params: {},
body: {
"pairs": [
{
"base": {
"currency": "CNY",
"issuer": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK"
},
"counter": {
"currency": "XRP"
}
},
{
"base": {
"currency": "MXN",
"issuer": "rG6FZ31hDHN1K5Dkbma3PSB5uVCuVVRzfn"
},
"counter": {
"currency": "USD",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q"
}
}
],
"range": "day"
}
});
Request('Issuer Capitalization', {
method: POST,
path: "/api/issuer_capitalization",
description: "Retrieve the total capitalization (outstanding balance) of specified currency issuers over time.",
link: "#issuer-capitalization",
params: {},
body: {
"currencies": [
{
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
},
{
"currency": "USD",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q"
}
],
"startTime": "Jan 1, 2014",
"endTime": "Jan 1, 2015",
"timeIncrement": "month"
}
});
Request('Ledgers Closed', {
method: POST,
path: "/api/ledgers_closed",
description: "Retrieve information about ledgers closed over time.",
link: "#ledgers-closed",
params: {},
body: {
"startTime": "2014-01-01",
"endTime": "2015-01-01",
"timeIncrement": "month",
"descending": false,
"reduce": true,
"format": "json"
}
});
Request('Market Traders', {
method: POST,
path: "/api/market_traders",
description: "Return a list of accounts that participated in trading a specified currency exchange.",
link: "#market-traders",
params: {},
body: {
"base": {
"currency": "XRP"
},
"counter": {
"currency": "KRW",
"issuer": "rUkMKjQitpgAM5WTGk79xpjT38DEJY283d"
},
"startTime": "2014-11-01",
"transactions": true,
"format": "json"
}
});
Request('Offers', {
method: POST,
path: "/api/offers",
description: "Returns all currency-exchange orders and cancellations over time for a specified currency pair, including unfulfilled offers.",
link: "#offers",
params: {},
body: {
"base": {
"currency": "GBP",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q"
},
"counter": {
"currency": "XRP"
},
"startTime": "2015-03-01",
"endTime": "2015-03-7",
"timeIncrement": "day",
"descending": false,
"reduce": true,
"format": "json"
}
});
Request('Offers Exercised', {
method: POST,
path: "/api/offers_exercised",
description: "Retrieve information about currency-exchange orders being exercised on the network, for a specific pair of currencies and timeframe.",
link: "#offers-exercised",
params: {},
body: {
"base": {
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
},
"counter": {
"currency": "BTC",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
},
"endTime": "2015-03-01T00:00Z",
"startTime": "2015-03-01T12:00Z",
"timeIncrement": "minute",
"timeMultiple": 15,
"format": "json"
}
});
Request('Top Markets', {
method: POST,
path: "/api/top_markets",
description: "Returns the total trade volume for a selection of the largest currency-exchange markets in the Ripple Network during a given time period.",
link: "#top-markets",
params: {},
body: {
"startTime": "2015-01-15 7:00 AM",
"endTime": "2015-01-16 8:00 PM",
"exchange": {
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
}
}
});
Request('Total Network Value', {
method: POST,
path: "/api/total_network_value",
description: "Retrieve the total amount of currency held in the network, as of a specified time.",
link: "#total-network-value",
params: {},
body: {
"time": "2014-12-24",
"exchange":{
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
}
}
});
Request('Total Value Sent', {
method: POST,
path: "/api/total_value_sent",
description: "The total amount of money sent, in payments and currency exchanges, for a curated list of currencies and issuers.",
link: "#total-value-sent",
params: {},
body: {
"startTime": "2014-01-15 7:00 AM",
"endTime": "2014-01-16 8:00 PM",
"exchange": {
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
}
}
});
Request('Transaction Stats', {
method: POST,
path: "/api/transaction_stats",
description: "Retrieve information about Ripple transactions during a specific time frame.",
link: "#transaction-stats",
params: {},
body: {
"startTime": "2015-01-15 07:00 Z",
"endTime": "2015-01-15 10:00 Z",
"timeIncrement": "hour",
"descending": true,
"reduce": true,
"format": "json"
}
});
Request('Value Sent', {
method: POST,
path: "/api/value_sent",
description: "Retrieve the total amount of a single currency sent, in payments and currency exchanges, during a specific time period.",
link: "#value-sent",
params: {},
body: {
"currency": "JPY",
"issuer": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN",
"startTime": "2015-01-15 08:00 Z",
"endTime": "2015-01-15 10:59 Z",
"timeIncrement": "hour",
"descending": false,
"reduce": true,
"format": "json"
}
});
//---------- End req. List ---------------------------//

View File

@@ -92,6 +92,7 @@
<li><a href="rest-api-tool.html">Ripple-REST API Tool</a></li>
<li><a href="historicaldb-api-tool.html">Historical Database API Tool</a></li>
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
<li><a href="charts-api-tool.html">Charts API Tool</a></li>
</ul>
</li>
<li class="dropdown">

View File

@@ -65,6 +65,7 @@
<li><a href="rest-api-tool.html">Ripple-REST API Tool</a></li>
<li><a href="historicaldb-api-tool.html">Historical Database API Tool</a></li>
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
<li><a href="charts-api-tool.html">Charts API Tool</a></li>
</ul>
</li>
<li class="dropdown">

View File

@@ -65,6 +65,7 @@
<li><a href="rest-api-tool.html">Ripple-REST API Tool</a></li>
<li><a href="historicaldb-api-tool.html">Historical Database API Tool</a></li>
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
<li><a href="charts-api-tool.html">Charts API Tool</a></li>
</ul>
</li>
<li class="dropdown">

View File

@@ -92,6 +92,7 @@
<li><a href="rest-api-tool.html">Ripple-REST API Tool</a></li>
<li><a href="historicaldb-api-tool.html">Historical Database API Tool</a></li>
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
<li><a href="charts-api-tool.html">Charts API Tool</a></li>
</ul>
</li>
<li class="dropdown">

View File

@@ -92,6 +92,7 @@
<li><a href="rest-api-tool.html">Ripple-REST API Tool</a></li>
<li><a href="historicaldb-api-tool.html">Historical Database API Tool</a></li>
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
<li><a href="charts-api-tool.html">Charts API Tool</a></li>
</ul>
</li>
<li class="dropdown">

View File

@@ -75,6 +75,14 @@
"template":"template-ripple-api-tool.html",
"is_apitool": true,
"html": "ripple-api-tool.html"
},
{
"name": "Charts API Tool",
"template":"template-rest-api-tool.html",
"methods_js": "js/apitool-methods-charts.js",
"is_apitool": true,
"rest_host": "https://api.ripplecharts.com",
"html": "charts-api-tool.html"
}
]

View File

@@ -92,6 +92,7 @@
<li><a href="rest-api-tool.html">Ripple-REST API Tool</a></li>
<li><a href="historicaldb-api-tool.html">Historical Database API Tool</a></li>
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
<li><a href="charts-api-tool.html">Charts API Tool</a></li>
</ul>
</li>
<li class="dropdown">

View File

@@ -92,6 +92,7 @@
<li><a href="rest-api-tool.html">Ripple-REST API Tool</a></li>
<li><a href="historicaldb-api-tool.html">Historical Database API Tool</a></li>
<li><a href="ripple-api-tool.html">WebSocket API Tool</a></li>
<li><a href="charts-api-tool.html">Charts API Tool</a></li>
</ul>
</li>
<li class="dropdown">