diff --git a/README.md b/README.md index 604a10f..ebe49c6 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,19 @@ send a `get` request to `https://api.chainz.rest/quote` } ``` +#### 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](quote/quotes.py) and is subject to change. An example return from [https://api.chainz.rest/quote?batch=2](https://api.chainz.rest/quote?batch=2): + +```json +{ + "quotes": [ + "I'm in the kitchen. Yams errrrrwhere.", + "Started from the trap, now I rap" + ] +} +``` + [Source Code](quote/__init__.py) ### Alias