# Stats

These commands return statistical information from Piri system.

## Get rich list

> This endpoint is used on the PIRI network to access a list of wallets that hold the most of the given "assetID" asset type. Skip and limit parameters can be used for pagination.

```json
{"openapi":"3.0.3","info":{"title":"Pirichain API","version":"1.1.0"},"tags":[{"name":"Stats","description":"These commands return statistical information from Piri system."}],"servers":[{"url":"https://core.pirichain.com","description":"Pirichain MainNet","variables":{}},{"url":"https://testnet.pirichain.com","description":"Pirichain TestNet","variables":{}},{"url":"https://{URL}","description":"You can only use https protocol for your custom environment.","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}},{"url":"http://{URL}","description":"Custom HTTP endpoint for development environment (not recommended for production).","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}}],"paths":{"/getRichList":{"post":{"tags":["Stats"],"summary":"Get rich list","description":"This endpoint is used on the PIRI network to access a list of wallets that hold the most of the given \"assetID\" asset type. Skip and limit parameters can be used for pagination.","operationId":"getRichList","requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"required":["assetID","limit"],"type":"object","properties":{"assetID":{"type":"string","description":"Asset ID"},"limit":{"type":"number","description":"Record count for per page"},"skip":{"type":"number","description":"Page count for skip according to limit value."}}}}},"required":false},"responses":{"200":{"description":"OK","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/getRichList"}}}}},"deprecated":false}}},"components":{"schemas":{"getRichList":{"required":["error","count","data"],"type":"object","properties":{"error":{"type":"integer","format":"int32","description":"Error status code. 0 indicates success, non-zero indicates an error."},"count":{"type":"integer","format":"int32","description":"Total number of rich wallets found for the specified asset."},"data":{"type":"array","items":{"$ref":"#/components/schemas/RichListEntry"},"description":"Array of wallet entries ordered by balance amount (highest to lowest)."}}},"RichListEntry":{"required":["_id","address","assetID","balance"],"type":"object","properties":{"_id":{"type":"string","description":"Unique database identifier for this wallet entry."},"address":{"type":"string","description":"The PIRI wallet address holding the asset."},"assetID":{"type":"integer","format":"int32","description":"The asset identifier. -1 represents native PIRI tokens."},"balance":{"type":"number","description":"The current balance amount of the specified asset in this wallet."}}}}}}
```

## Get detailed statistics

> This endpoint returns the total transaction count for the last 10 processed days on the PIRI network in the form of a statistical series.

```json
{"openapi":"3.0.3","info":{"title":"Pirichain API","version":"1.1.0"},"tags":[{"name":"Stats","description":"These commands return statistical information from Piri system."}],"servers":[{"url":"https://core.pirichain.com","description":"Pirichain MainNet","variables":{}},{"url":"https://testnet.pirichain.com","description":"Pirichain TestNet","variables":{}},{"url":"https://{URL}","description":"You can only use https protocol for your custom environment.","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}},{"url":"http://{URL}","description":"Custom HTTP endpoint for development environment (not recommended for production).","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}}],"paths":{"/getDetailStats":{"post":{"tags":["Stats"],"summary":"Get detailed statistics","description":"This endpoint returns the total transaction count for the last 10 processed days on the PIRI network in the form of a statistical series.","operationId":"getDetailStats","requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"type":"object","properties":{"assetID":{"type":"string","description":"Asset ID"}}}}},"required":false},"responses":{"200":{"description":"OK","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/getDetailStat"},"description":"Array of daily transaction statistics for the last 10 processed days"}}}}},"deprecated":false}}},"components":{"schemas":{"getDetailStat":{"required":["_id","count"],"type":"object","properties":{"_id":{"type":"string","description":"The date identifier in YYYY-MM-DD format representing the day for which statistics are reported."},"count":{"type":"integer","format":"int32","description":"The total number of transactions processed on this specific date."}}}}}}
```

## Get statistics

> This endpoint is used to display summary information related to the PIRI network.

```json
{"openapi":"3.0.3","info":{"title":"Pirichain API","version":"1.1.0"},"tags":[{"name":"Stats","description":"These commands return statistical information from Piri system."}],"servers":[{"url":"https://core.pirichain.com","description":"Pirichain MainNet","variables":{}},{"url":"https://testnet.pirichain.com","description":"Pirichain TestNet","variables":{}},{"url":"https://{URL}","description":"You can only use https protocol for your custom environment.","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}},{"url":"http://{URL}","description":"Custom HTTP endpoint for development environment (not recommended for production).","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}}],"paths":{"/getStats":{"post":{"tags":["Stats"],"summary":"Get statistics","description":"This endpoint is used to display summary information related to the PIRI network.","operationId":"getStats","responses":{"200":{"description":"OK","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/getStats"}}}}},"deprecated":false}}},"components":{"schemas":{"getStats":{"required":["blockCount","transactionCount","poolTransactionCount","tokenCount","addressCount","customDataSize","totalBurnedPiri","deputyCount","totalFrozenData"],"type":"object","properties":{"blockCount":{"type":"integer","format":"int32","description":"Total number of blocks processed in the PIRI network."},"transactionCount":{"type":"integer","format":"int32","description":"Total number of transactions completed in the network."},"poolTransactionCount":{"type":"integer","format":"int32","description":"Number of transactions currently waiting in the transaction pool."},"tokenCount":{"type":"integer","format":"int32","description":"Total number of tokens created on the PIRI network."},"addressCount":{"type":"integer","format":"int32","description":"Total number of unique addresses that have been active on the network."},"customDataSize":{"type":"string","description":"Total size of custom data stored on the blockchain, displayed in human-readable format."},"totalBurnedPiri":{"type":"array","items":{"$ref":"#/components/schemas/TotalBurnedPiri"},"description":"Array containing information about total PIRI tokens that have been burned."},"deputyCount":{"type":"integer","format":"int32","description":"Current number of deputy nodes participating in the network consensus."},"totalFrozenData":{"type":"array","items":{"$ref":"#/components/schemas/TotalFrozenData"},"description":"Array containing information about total frozen PIRI tokens in the network."}}},"TotalBurnedPiri":{"required":["_id","total"],"type":"object","properties":{"_id":{"type":"string","nullable":true,"description":"Identifier for the burned tokens aggregation (typically null for total sum)."},"total":{"type":"number","description":"Total amount of PIRI tokens that have been permanently burned."}}},"TotalFrozenData":{"required":["_id","totalFrozen"],"type":"object","properties":{"_id":{"type":"string","nullable":true,"description":"Identifier for the frozen tokens aggregation (typically null for total sum)."},"totalFrozen":{"type":"number","description":"Total amount of PIRI tokens that are currently frozen in delegation."}}}}}}
```

## Get circulation

> This endpoint provides the total amount of PIRI circulating in the PIRI network.

```json
{"openapi":"3.0.3","info":{"title":"Pirichain API","version":"1.1.0"},"tags":[{"name":"Stats","description":"These commands return statistical information from Piri system."}],"servers":[{"url":"https://core.pirichain.com","description":"Pirichain MainNet","variables":{}},{"url":"https://testnet.pirichain.com","description":"Pirichain TestNet","variables":{}},{"url":"https://{URL}","description":"You can only use https protocol for your custom environment.","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}},{"url":"http://{URL}","description":"Custom HTTP endpoint for development environment (not recommended for production).","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}}],"paths":{"/getCirculation":{"post":{"tags":["Stats"],"summary":"Get circulation","description":"This endpoint provides the total amount of PIRI circulating in the PIRI network.","operationId":"getCirculation","responses":{"200":{"description":"OK","content":{"application/json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/getCirculation"}}}}},"deprecated":false}}},"components":{"schemas":{"getCirculation":{"required":["error","amount"],"type":"object","properties":{"error":{"type":"integer","format":"int32","description":"Error status code. 0 indicates success, non-zero indicates an error."},"amount":{"type":"integer","format":"int32","description":"The total amount of PIRI tokens currently circulating in the network."}}}}}}
```

## Get total burned PIRI

> This endpoint is used to list the amount of PIRI burned in the PIRI network in the last 10 days.

```json
{"openapi":"3.0.3","info":{"title":"Pirichain API","version":"1.1.0"},"tags":[{"name":"Stats","description":"These commands return statistical information from Piri system."}],"servers":[{"url":"https://core.pirichain.com","description":"Pirichain MainNet","variables":{}},{"url":"https://testnet.pirichain.com","description":"Pirichain TestNet","variables":{}},{"url":"https://{URL}","description":"You can only use https protocol for your custom environment.","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}},{"url":"http://{URL}","description":"Custom HTTP endpoint for development environment (not recommended for production).","variables":{"URL":{"default":"custom.network","description":"You can enter your custom endpoint which belong to Pirichain Network"}}}],"paths":{"/getTotalBurnedPiri":{"post":{"tags":["Stats"],"summary":"Get total burned PIRI","description":"This endpoint is used to list the amount of PIRI burned in the PIRI network in the last 10 days.","operationId":"getTotalBurnedPiri","responses":{"200":{"description":"OK","content":{"application/json; charset=utf-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BurnedPiriEntry"}}}}}},"deprecated":true}}},"components":{"schemas":{"BurnedPiriEntry":{"required":["_id","count"],"type":"object","properties":{"_id":{"type":"string","description":"The date identifier in YYYY-MM-DD format representing the day for which burned PIRI statistics are reported."},"count":{"type":"number","description":"The total amount of PIRI tokens burned on this specific date."}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://api.pirichain.com/stats.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.