Documentation

README.md

@@ -2,13 +2,16 @@
 
 [![.github/workflows/bun-test.yml](https://github.com/pinax-network/antelope-token-api/actions/workflows/bun-test.yml/badge.svg)](https://github.com/pinax-network/antelope-token-api/actions/workflows/bun-test.yml)
 
-> Token prices from the Antelope blockchains
+> Token balances, supply and transfers from the Antelope blockchains
 
 ## REST API
 
 | Pathname                                  | Description           |
 |-------------------------------------------|-----------------------|
 | GET `/chains`                             | Available `chains`
+| GET `/supply`                             | Antelope Tokens total supply
+| GET `/balance`                            | Antelope Tokens balance changes
+| GET `/transfers`                          | Antelope Tokens transfers
 | GET `/health`                             | Health check
 | GET `/metrics`                            | Prometheus metrics
 | GET `/openapi`                            | [OpenAPI v3 JSON](https://spec.openapis.org/oas/v3.0.0)
@@ -25,8 +28,17 @@ $ bun install
 $ bun dev
 ```
 
+**Tests**
+```console
+$ bun lint
+$ bun test
+```
+
 ## [`Bun` Binary Releases](https://github.com/pinax-network/substreams-sink-websockets/releases)
 
+> [!NOTE]  
+> Currently not available
+
 > Linux Only
 
 ```console
@@ -53,14 +65,11 @@ MAX_LIMIT=500
 VERBOSE=true
 ```
 
-## Help
-
-```console
-
-```
-
 ## Docker environment
 
+> [!NOTE]  
+> Currently not available
+
 Pull from GitHub Container registry
 ```bash
 docker pull ghcr.io/pinax-network/antelope-token-api:latest

src/fetch/openapi.ts

@@ -166,7 +166,7 @@ export default new OpenApiBuilder()
   }).addPath("/transfers", {
     get: {
       tags: [TAGS.USAGE],
-      summary: "Antelope Tokens Transfers",
+      summary: "Antelope Tokens transfers",
       parameters: [
         parameterChain,
         parameterString("contract"),