1
0
mirror of https://gitlab.com/2-chainz/2-chainz-rest-site.git synced 2025-06-16 15:17:24 +00:00

added info on new endpoints

This commit is contained in:
Anson 2020-04-09 03:24:40 -07:00
parent 79ae632a05
commit 72bc3dfdad

View File

@ -100,16 +100,56 @@
<hr style="padding-top: 0;" /> <hr style="padding-top: 0;" />
<header id="scroll"> <header id="scroll">
<h2>Usage</h2> <h2>Usage</h2>
</header>
<details open>
<summary>Getting Quotes</summary>
<p> <p>
The API currently only has one endpoint: The <code>quotes</code> endpoint can be accessed here:
<code <code
><a href="https://api.chainz.rest/quote" ><a href="https://api.chainz.rest/quote"
>https://api.chainz.rest/quote</a >https://api.chainz.rest/quote</a
></code ></code
> >
which returns a JSON object containing a quote.
</p> </p>
<p>
This endpoint returns a 2 Chainz quote, and can optionally take the
<code>batch</code> parameter which allows requesting more than one
quote at a time.
</p></details
>
<details
><summary>Aliases</summary>
<p>
2 Chainz has gone by many different names throughout his career and
this endpoint lets you request a random <code>alias</code> that Tity
Boi has used over the years. Can be accessed here:
<code
><a href="https://api.chainz.rest/alias"
>https://api.chainz.rest/alias</a
></code
>
</p></details
>
<hr />
<section>
<header>
<h2>
Projects built using 2.chainz.rest (Your project could be here!)
</h2>
</header> </header>
<aside>
<h3>
<a href="https://t.me/twoChainzBot">2 Chainz Telegram Bot</a>
</h3>
<p>An inline Telegram bot that sends a random 2 Chainz Quote.</p>
<small
><a href="https://gitlab.com/2-chainz/2-chainz-telegram"
>Source code here.</a
>
</small>
</aside>
</section>
<hr /> <hr />
<section> <section>
<header> <header>