1
0
mirror of https://gitlab.com/2-chainz/2-chainz-rest.git synced 2025-08-03 03:51:24 +00:00

added a helpful readme

This commit is contained in:
2020-04-23 21:17:23 -07:00
parent 8cca96fff4
commit fc6cff1dca

View File

@@ -1,2 +1,33 @@
# 2 Chainz Rest
API for 2 Chainz quotes an aliases built using Python and Azure Functions. More project info at [2.chainz.rest](https://2.chainz.rest).
## Endpoints
### Quote
Returns a random 2 Chainz Quote in `json` format like the following example:
send a `get` request to `https://api.chainz.rest/quote`
```json
{
"quote": "I got a pocket full of money, it got me walking all slew-foot"
}
```
[Source Code](quote/__init__.py)
### 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](alias/aliases.py).
send a `get` request to `https://api.chainz.rest/alias`
```json
{
"alias": "Dos Cadenas"
}
```
[Source Code](alias/__init__.py)