mirror of
https://gitlab.com/2-chainz/2-chainz-rest.git
synced 2025-08-03 12:01:28 +00:00
added parameters to docs
This commit is contained in:
13
README.md
13
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
|
||||
|
Reference in New Issue
Block a user