-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #14 from bpringe/update-docs
Update docs
Showing
4 changed files
with
57 additions
and
82 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,3 @@ | ||
<!DOCTYPE html PUBLIC "" | ||
""> | ||
<html><head><meta charset="UTF-8" /><title>Coinbase-pro-clj 1.0.0</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Coinbase-pro-clj</span> <span class="project-version">1.0.0</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 "><a href="coinbase-pro-clj.core.html"><div class="inner"><span>coinbase-pro-clj.core</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Coinbase-pro-clj</span> <span class="project-version">1.0.0</span></span></h1><h5 class="license">Released under the <a href="https://opensource.org/licenses/MIT">MIT</a></h5><div class="doc"><p>A Clojure wrapper for the Coinbase Pro API (formerly GDAX).</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[coinbase-pro-clj "1.0.0"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="coinbase-pro-clj.core.html">coinbase-pro-clj.core</a></h3><div class="doc"><div class="markdown"><p>Public and private endpoint functions and websocket feed functionality. In all function signatures, <code>client</code> takes the following shape:</p> | ||
<pre><code class="clojure">{:url | ||
:key ; optional | ||
:secret ; optional | ||
:passphrase} ; optional | ||
</code></pre> | ||
<ul> | ||
<li><code>key</code>, <code>secret</code>, and <code>passphrase</code> are only required if the request is authenticated. These values can be created in the <a href="https://pro.coinbase.com/profile/api">API settings</a> of your Coinbase Pro account. <strong>Remember not to store these values in an online repository as this will give others access to your account. You could use something like <a href="https://github.com/weavejester/environ">environ</a> to store these values locally outside of your code.</strong></li> | ||
</ul></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="coinbase-pro-clj.core.html#var-cancel-all">cancel-all</a> </li><li> <a href="coinbase-pro-clj.core.html#var-cancel-order">cancel-order</a> </li><li> <a href="coinbase-pro-clj.core.html#var-close">close</a> </li><li> <a href="coinbase-pro-clj.core.html#var-create-websocket-connection">create-websocket-connection</a> </li><li> <a href="coinbase-pro-clj.core.html#var-deposit-from-coinbase">deposit-from-coinbase</a> </li><li> <a href="coinbase-pro-clj.core.html#var-deposit-from-payment-method">deposit-from-payment-method</a> </li><li> <a href="coinbase-pro-clj.core.html#var-generate-report">generate-report</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-24hour-stats">get-24hour-stats</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-account">get-account</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-account-history">get-account-history</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-account-holds">get-account-holds</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-accounts">get-accounts</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-coinbase-accounts">get-coinbase-accounts</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-currencies">get-currencies</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-fills">get-fills</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-historic-rates">get-historic-rates</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-order">get-order</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-order-book">get-order-book</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-orders">get-orders</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-payment-methods">get-payment-methods</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-products">get-products</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-report-status">get-report-status</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-ticker">get-ticker</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-time">get-time</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-trades">get-trades</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-trailing-volume">get-trailing-volume</a> </li><li> <a href="coinbase-pro-clj.core.html#var-place-order">place-order</a> </li><li> <a href="coinbase-pro-clj.core.html#var-rest-url">rest-url</a> </li><li> <a href="coinbase-pro-clj.core.html#var-sandbox-rest-url">sandbox-rest-url</a> </li><li> <a href="coinbase-pro-clj.core.html#var-sandbox-websocket-url">sandbox-websocket-url</a> </li><li> <a href="coinbase-pro-clj.core.html#var-subscribe">subscribe</a> </li><li> <a href="coinbase-pro-clj.core.html#var-unsubscribe">unsubscribe</a> </li><li> <a href="coinbase-pro-clj.core.html#var-websocket-url">websocket-url</a> </li><li> <a href="coinbase-pro-clj.core.html#var-withdraw-to-coinbase">withdraw-to-coinbase</a> </li><li> <a href="coinbase-pro-clj.core.html#var-withdraw-to-crypto-address">withdraw-to-crypto-address</a> </li><li> <a href="coinbase-pro-clj.core.html#var-withdraw-to-payment-method">withdraw-to-payment-method</a> </li></ul></div></div></div></body></html> | ||
<html><head><meta charset="UTF-8" /><title>Coinbase-pro-clj 1.0.0</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Coinbase-pro-clj</span> <span class="project-version">1.0.0</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 "><a href="coinbase-pro-clj.core.html"><div class="inner"><span>coinbase-pro-clj.core</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Coinbase-pro-clj</span> <span class="project-version">1.0.0</span></span></h1><h5 class="license">Released under the <a href="https://opensource.org/licenses/MIT">MIT</a></h5><div class="doc"><p>A Clojure wrapper for the Coinbase Pro API (formerly GDAX).</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[coinbase-pro-clj "1.0.0"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="coinbase-pro-clj.core.html">coinbase-pro-clj.core</a></h3><div class="doc"><div class="markdown"><p>Public and private endpoint functions and websocket feed functionality. In all function signatures, <code>client</code> is a map with the following keys: - <code>:url</code> - rest URL - <code>:key</code> - optional - your Coinbase Pro API key - <code>:secret</code> - optional - your Coinbase Pro API key - <code>:passphrase</code> - optional - your Coinbase Pro API key</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="coinbase-pro-clj.core.html#var-cancel-all">cancel-all</a> </li><li> <a href="coinbase-pro-clj.core.html#var-cancel-order">cancel-order</a> </li><li> <a href="coinbase-pro-clj.core.html#var-close">close</a> </li><li> <a href="coinbase-pro-clj.core.html#var-create-websocket-connection">create-websocket-connection</a> </li><li> <a href="coinbase-pro-clj.core.html#var-deposit-from-coinbase">deposit-from-coinbase</a> </li><li> <a href="coinbase-pro-clj.core.html#var-deposit-from-payment-method">deposit-from-payment-method</a> </li><li> <a href="coinbase-pro-clj.core.html#var-generate-report">generate-report</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-24hour-stats">get-24hour-stats</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-account">get-account</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-account-history">get-account-history</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-account-holds">get-account-holds</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-accounts">get-accounts</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-coinbase-accounts">get-coinbase-accounts</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-currencies">get-currencies</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-fills">get-fills</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-historic-rates">get-historic-rates</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-order">get-order</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-order-book">get-order-book</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-orders">get-orders</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-payment-methods">get-payment-methods</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-products">get-products</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-report-status">get-report-status</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-ticker">get-ticker</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-time">get-time</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-trades">get-trades</a> </li><li> <a href="coinbase-pro-clj.core.html#var-get-trailing-volume">get-trailing-volume</a> </li><li> <a href="coinbase-pro-clj.core.html#var-place-order">place-order</a> </li><li> <a href="coinbase-pro-clj.core.html#var-rest-url">rest-url</a> </li><li> <a href="coinbase-pro-clj.core.html#var-sandbox-rest-url">sandbox-rest-url</a> </li><li> <a href="coinbase-pro-clj.core.html#var-sandbox-websocket-url">sandbox-websocket-url</a> </li><li> <a href="coinbase-pro-clj.core.html#var-subscribe">subscribe</a> </li><li> <a href="coinbase-pro-clj.core.html#var-unsubscribe">unsubscribe</a> </li><li> <a href="coinbase-pro-clj.core.html#var-websocket-url">websocket-url</a> </li><li> <a href="coinbase-pro-clj.core.html#var-withdraw-to-coinbase">withdraw-to-coinbase</a> </li><li> <a href="coinbase-pro-clj.core.html#var-withdraw-to-crypto-address">withdraw-to-crypto-address</a> </li><li> <a href="coinbase-pro-clj.core.html#var-withdraw-to-payment-method">withdraw-to-payment-method</a> </li></ul></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters