Introduction
Unlock the power of Rise of Stats and take your data analysis to new heights. Our API documentation is your ultimate guide to seamlessly integrate and leverage the full potential of our services.
Robust Functionality
Rise of Stats offers a wide range of features and capabilities to suit your specific needs, ensuring your applications are more powerful and versatile than ever.
Easy Integration
We've designed Rise of Stats API to be developer-friendly, with clear and concise documentation and code samples to help you get up and running quickly.
Community Support
Join a vibrant community of developers and enthusiasts who are eager to share their knowledge and experience, making it easier than ever to get assistance and collaborate.
Function Structure
api.riseofstats.com
-
/scan
- /list – Get a list of all available scans
- /view – View details of specific scan
- /data – Get all data attached to specific scan
-
/governor
- /list – Get a list of all governors within a kingdom
- /data – Get all data attached to specific governor
-
/power
- /list – Get a list of all available power scans
- /data – Get power value of a specific power scan
-
/tag
- /list – Get a list of all available tags
Starter template
Endpoints
The `/scan/list` endpoint allows you to retrieve a list of scans that are attached to a specific kingdom. This endpoint provides information about each scan, including its unique identifier (id), name, and date of the scan.
Endpoint
- URL: `/scan/list`
- Method: POST
Parameters
Name | Type | Description |
---|---|---|
auth_key | str | Authentication key |
secret | str | Secret key |
limit | Int | (Optional) Limits the number of scans returned in the list. |
before | date | (Optional) Format "yyyy-mm-dd", eg. 2023-01-31. |
after | date | (Optional) Format "yyyy-mm-dd", eg. 2023-01-31. |
spy | Bool | (Optional) 1, to select only spy scans. |
tag | Int | Coming Soon |
Example Request
Response
Success Response
- Status Code: 200 OK
The response is a JSON array containing scan objects, each with the following attributes:
- `id`(int): The unique identifier for the scan.
- `name`(string): The name of the scan.
- `date`(string): The date and time when the scan was performed in the format "YYYY-MM-DD HH:MM:SS".
Example Response
Failure Response
- 400 Bad Request You are missing required parameters.
- 401 Unauthorized: Missing or incorrectly Authentication key & Secret.
- 403 Forbidden: You do not have access to this data.
- 404 Not Found: The provided endpoint or function provided is non-existent.
- 422 Unprocessable Entity: Request method does not equal to POST.
- 500 Internal Server Error: Server issues, best to contact support.
The `/scan/view` endpoint allows you to retrieve detailed information about a specific scan by specifying its unique identifier (`id`). This endpoint provides details such as the scan's `id`, `name`, and `date`.
Endpoint
- URL: `/scan/view`
- Method: POST
Parameters
Name | Type | Description |
---|---|---|
id | Int | (Required) Unique identifier of the scan. |
auth_key | str | Authentication key |
secret | str | Secret key |
Example Request
Response
Success Response
- Status Code: 200 OK
The response is a JSON array containing scan objects, each with the following attributes:
- `id`(int): The unique identifier for the scan.
- `name`(string): The name of the scan.
- `date`(string): The date and time when the scan was performed in the format "YYYY-MM-DD HH:MM:SS".
Example Response
Failure Response
- 400 Bad Request You are missing required parameters.
- 401 Unauthorized: Missing or incorrectly Authentication key & Secret.
- 403 Forbidden: You do not have access to this data.
- 404 Not Found: The provided endpoint or function provided is non-existent.
- 422 Unprocessable Entity: Request method does not equal to POST.
- 500 Internal Server Error: Server issues, best to contact support.
The `/scan/data` endpoint allows you to retrieve data attached to a specific scan by specifying its unique identifier (`id`). This endpoint provides details about governors and their associated data, such as `governor_id`, `username`, `power`, `kills` for different troop types (`kills_t_1`, `kills_t_2`, `kills_t_3`, `kills_t_4`, `kills_t_5`), `deads`, `assistance`, and `helps`.
Endpoint
- URL: `/scan/view`
- Method: POST
Parameters
Name | Type | Description |
---|---|---|
id | Int | (Required) Unique identifier of the scan. |
auth_key | str | Authentication key |
secret | str | Secret key |
limit | Int | (Optional) Limits the number of scans returned in the list. |
min_power | Int | (Optional) Set the minimum power value. |
max_power | Int | (Optional) Set the maximum power value. |
tag | Int | Coming Soon |
Example Request
Response
Success Response
- Status Code: 200 OK
The response is a JSON array containing data objects for governors associated with the scan. Each governor data object has the following attributes:
- governor_id (int): The unique identifier of the governor.
- username (string): The username of the governor.
- power (int): The power of the governor.
- kills_t_1 (int): Kills of troop type 1.
- kills_t_2 (int): Kills of troop type 2.
- kills_t_3 (int): Kills of troop type 3.
- kills_t_4 (int): Kills of troop type 4.
- kills_t_5 (int): Kills of troop type 5.
- deads (int): The number of times the governor died.
- assistance (int): The amount of assistance provided.
- helps (int): The number of helps received.
Example Response
Failure Response
- 400 Bad Request You are missing required parameters.
- 401 Unauthorized: Missing or incorrectly Authentication key & Secret.
- 403 Forbidden: You do not have access to this data.
- 404 Not Found: The provided endpoint or function provided is non-existent.
- 422 Unprocessable Entity: Request method does not equal to POST.
- 500 Internal Server Error: Server issues, best to contact support.
The `/governor/list` endpoint allows you to retrieve a list of governors attached to a specific kingdom. This endpoint provides information about each governor, including their unique identifier (`id`) and username.
Endpoint
- URL: `/governor/list`
- Method: POST
Parameters
Name | Type | Description |
---|---|---|
auth_key | str | Authentication key |
secret | str | Secret key |
limit | Int | (Optional) Limit of results to be returned, default set on 100. |
min_power | Int | (Optional) Set the minimum power value. |
max_power | Int | (Optional) Set the maximum power value. |
tag | Int | Coming Soon |
Example Request
Response
Success Response
- Status Code: 200 OK
The response is a JSON array containing governor objects, each with the following attributes:
- `id`(int): The unique identifier for the governor.
- `username`(string): The username of the governor.
Example Response
Failure Response
- 400 Bad Request You are missing required parameters.
- 401 Unauthorized: Missing or incorrectly Authentication key & Secret.
- 403 Forbidden: You do not have access to this data.
- 404 Not Found: The provided endpoint or function provided is non-existent.
- 422 Unprocessable Entity: Request method does not equal to POST.
- 500 Internal Server Error: Server issues, best to contact support.
The `/governor/data` endpoint allows you to retrieve data about governors attached to a specific kingdom by specifying their unique identifier (`governor_id`). This endpoint provides details about governors, including their `governor_id`, `username`, `power`, `kills` for different troop types (`kills_t_1`, `kills_t_2`, `kills_t_3`, `kills_t_4`, `kills_t_5`), `deads`, `assistance`, and `helps`.
Endpoint
- URL: `/governor/data`
- Method: POST
Parameters
Name | Type | Description |
---|---|---|
id | Int | (Required) Unique identifier of the governor. |
auth_key | str | Authentication key |
secret | str | Secret key |
limit | Int | Coming Soon |
Example Request
Response
Success Response
- Status Code: 200 OK
The response is a JSON array containing data objects for governors associated with the specified governor `id`. Each governor data object has the following attributes:
- governor_id (int): The unique identifier of the governor.
- username (string): The username of the governor.
- power (int): The power of the governor.
- kills_t_1 (int): Kills of troop type 1.
- kills_t_2 (int): Kills of troop type 2.
- kills_t_3 (int): Kills of troop type 3.
- kills_t_4 (int): Kills of troop type 4.
- kills_t_5 (int): Kills of troop type 5.
- deads (int): The number of times the governor died.
- assistance (int): The amount of assistance provided.
- helps (int): The number of helps received.
- scan_id (int): The scan identifier associated with the governor data.
Example Response
Failure Response
- 400 Bad Request You are missing required parameters.
- 401 Unauthorized: Missing or incorrectly Authentication key & Secret.
- 403 Forbidden: You do not have access to this data.
- 404 Not Found: The provided endpoint or function provided is non-existent.
- 422 Unprocessable Entity: Request method does not equal to POST.
- 500 Internal Server Error: Server issues, best to contact support.
The `/power/list` endpoint allows you to retrieve a list of power scans that are attached to a specific kingdom. This endpoint provides information about each scan, including its unique identifier (id), power, and date of the scan.
Endpoint
- URL: `/power/list`
- Method: POST
Parameters
Name | Type | Description |
---|---|---|
auth_key | str | Authentication key |
secret | str | Secret key |
limit | Int | (Optional) Limits the number of scans returned in the list. |
before | date | (Optional) Format "yyyy-mm-dd", eg. 2023-01-31. |
after | date | (Optional) Format "yyyy-mm-dd", eg. 2023-01-31. |
spy | Bool | (Optional) 1, to select only spy scans. |
tag | Int | Coming Soon |
Example Request
Response
Success Response
- Status Code: 200 OK
The response is a JSON array containing scan objects, each with the following attributes:
- `id`(int): The unique identifier for the scan.
- `name`(string): The name of the scan.
- `date`(string): The date and time when the scan was performed in the format "YYYY-MM-DD HH:MM:SS".
Example Response
Failure Response
- 400 Bad Request You are missing required parameters.
- 401 Unauthorized: Missing or incorrectly Authentication key & Secret.
- 403 Forbidden: You do not have access to this data.
- 404 Not Found: The provided endpoint or function provided is non-existent.
- 422 Unprocessable Entity: Request method does not equal to POST.
- 500 Internal Server Error: Server issues, best to contact support.
The `/power/list` endpoint allows you to retrieve a list of power scans that are attached to a specific kingdom. This endpoint provides information about each scan, including its unique identifier (id), name, and date of the scan.
Endpoint
- URL: `/power/list`
- Method: POST
Parameters
Name | Type | Description |
---|---|---|
id | Int | (Required) Unique identifier of the scan. |
auth_key | str | Authentication key |
secret | str | Secret key |
Example Request
Response
Success Response
- Status Code: 200 OK
The response is a JSON array containing scan objects, each with the following attributes:
- `scan_id`(int): The unique identifier for the scan.
- `kingdom`(int): The # of the kingdom attached.
- `power`(int): The scanned power value.
Example Response
Failure Response
- 400 Bad Request You are missing required parameters.
- 401 Unauthorized: Missing or incorrectly Authentication key & Secret.
- 403 Forbidden: You do not have access to this data.
- 404 Not Found: The provided endpoint or function provided is non-existent.
- 422 Unprocessable Entity: Request method does not equal to POST.
- 500 Internal Server Error: Server issues, best to contact support.