Usage¶
Here you will learn how to best use Rock API and take full advantage of the features it has to offer.
Base URL¶
https://rockapi.apiworks.tech/rock/
Searching For Rocks¶
Type |
URL |
Parameters |
|---|---|---|
GET |
/<rock name> |
rock name |
Warning
Rock names must be lowercase and the exact name of the rock you are searching for.
Random Rocks¶
Type |
URL |
Parameters |
|---|---|---|
GET |
/random |
none |
Top Rocks¶
Find a random rock that is rated 5 stars.
Type |
URL |
Parameters |
|---|---|---|
GET |
/top |
none |
Rock Count¶
Type |
URL |
Parameters |
|---|---|---|
GET |
/count |
none |
Rate Rocks¶
NEW URL
https://rockapi.apiworks.tech/rate/
Type |
URL |
Parameters |
|---|---|---|
PATCH |
/<rock name> |
rating : int |
Python Example
import requests
BASE = "https://rockapi.apiworks.tech/"
response = requests.patch(BASE + "rate/" + "test", {"rating":3})
print(response.json())