diff --git a/index.html b/index.html index e609fb9..33d5864 100644 --- a/index.html +++ b/index.html @@ -105,35 +105,63 @@

Usage

- Getting Quotes + Quote +

- The quotes endpoint can be accessed here: - https://api.chainz.rest/quote + Returns a random 2 Chainz Quote in json format like the + following example:

-

- This endpoint returns a 2 Chainz quote, and can optionally take the - batch parameter which allows requesting more than one - quote at a time. -

+ +

send a get request to

+ + 
{
+          "quote": "I got a pocket full of money, it got me walking all slew-foot"
+        }
+ +
+ Parameters + +

+ This endpoint also supports an optional batch parameter + to get more than one quote per request. Maximum quotes that the + endpoint will return is the amount of quotes in + quotes.py + and is subject to change. An example return from + https://api.chainz.rest/quote?batch=2: +

+ + 
{
+            "quotes": [
+              "I'm in the kitchen. Yams errrrrwhere.",
+              "Started from the trap, now I rap"
+            ]
+        }
+
+
Aliases + >Alias

- 2 Chainz has gone by many different names throughout his career and - this endpoint lets you request a random alias that Tity - Boi has used over the years. Can be accessed here: - https://api.chainz.rest/alias -

+ Returns a random 2 Chainz alias in json format. The + return values are weighted and a full list can be seen in + aliases.py. +

+

+ send a get request to + https://api.chainz.rest/alias +

+ 
{
+          "alias": "Dos Cadenas"
+        }
+