From 73943f73e2002349ca65bb7edca0a7313b16da82 Mon Sep 17 00:00:00 2001
From: Alexis Hernandez <alexis22229@gmail.com>
Date: Fri, 21 Dec 2018 22:23:43 -0700
Subject: [PATCH] Add a summary for the public JSON API

---
 README.md   |  3 +++
 api_docs.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 60 insertions(+)
 create mode 100644 api_docs.md

diff --git a/README.md b/README.md
index 6da6964..7e84488 100644
--- a/README.md
+++ b/README.md
@@ -14,5 +14,8 @@ The web-ui is the frontend application that interacts with the `server` project
 ## infra
 The infra project contains all stuff related to the required infrastructure, like deployment steps and hopefully deployment scripts (TODO).
 
+# Public JSON API
+See the [api_docs](api_docs.md).
+
 # Contributing
 We are happy to accept contributions, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file to see our rules.
diff --git a/api_docs.md b/api_docs.md
new file mode 100644
index 0000000..62598a6
--- /dev/null
+++ b/api_docs.md
@@ -0,0 +1,57 @@
+# Explorer API
+Disclaimer: This documentation might have issues, the best way to get understand how is the API used is to use the developer tools from your favorite browser while browsing the explorer website.
+
+All endpoints are accessible at `https://xsnexplorer.io/api/xsn/`, for accessing the `/health` endpoint, load `https://xsnexplorer.io/api/xsn/health`
+
+
+## Statistics
+
+## GET /stats
+
+Retrieves statistics: `curl https://xsnexplorer.io/api/xsn/stats`
+
+
+## Transactions
+
+### GET /transactions/:txid
+
+Retrieves a transaction by id: `curl https://xsnexplorer.io/api/xsn/transactions/efa97e3f55d3722df678986c7c275d63e8a2aa169b164c932c1f6dd8755356ad`
+
+### GET /transactions/:txid/raw
+Retrieves the raw transaction by id: `curl https://xsnexplorer.io/api/xsn/stats`
+
+
+
+## Addresses
+
+### GET /addresses/:address
+Retrieves info about an address: `curl https://xsnexplorer.io/api/xsn/addresses/XvoBWMPo1NFstmCCTWZQ8w4BcmHXddNLxX`
+
+### GET /addresses/:address/transactions
+
+Retrieves the transactions for an address: `curl "https://xsnexplorer.io/api/xsn/addresses/XvoBWMPo1NFstmCCTWZQ8w4BcmHXddNLxX/transactions?offset=0&limit=10&orderBy=time:desc"`
+
+Note: ordering and pagination are optional.
+
+
+
+## Blocks
+
+### GET /blocks
+
+Retrieves the latest blocks: `curl https://xsnexplorer.io/api/xsn/blocks`
+
+### GET /blocks/:query
+Retrieves a block: `curl https://xsnexplorer.io/api/xsn/blocks/20`
+
+Note: `:query` could be a blockhash or block height.
+
+### GET /blocks/:query/raw
+Retrieves a raw block: `curl https://xsnexplorer.io/api/xsn/blocks/20/raw`
+
+Note: `:query` could be a blockhash or block height.
+
+### GET /blocks/:blockhash/transactions
+Retrieves the transactions on the given block: `curl "https://xsnexplorer.io/api/xsn/blocks/31791420aa1d096c84317a3ba40f448ee5fe5a1c6f8c21a02f026e5135b624b4/transactions?offset=0&limit=5&orderBy=time:desc"`
+
+Note: ordering and pagination are optional.