Skip to content

docs: fix API table — add token filter and locked/progress fields #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
natho080 wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −3
Open

docs: fix API table — add token filter and locked/progress fields #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,13 @@ current clock, so the numbers are always current without a chain round-trip.
| --- | --- | --- |
| `GET` | `/health` | Liveness check. |
| `GET` | `/status` | Indexer progress against the chain. |
| `GET` | `/streams` | List streams. Query params: `sender`, `recipient`, `limit` (max 100), `offset`. |
| `GET` | `/streams` | List streams. Query params: `sender`, `recipient`, `token`, `limit` (max 100), `offset`. |
| `GET` | `/streams/:id` | A single stream by id. |

Each stream is returned with its stored fields plus derived `vested`,
`withdrawable`, and `status` (`pending`, `streaming`, `completed`, or
`cancelled`). All amounts are strings to preserve 128-bit precision.
`withdrawable`, `locked`, `progress` (basis points, 0–10000), and `status`
(`pending`, `streaming`, `completed`, or `cancelled`). All amounts are strings
to preserve 128-bit precision.

`/status` reports the indexer's own position and the chain's head as two
separate figures, because only the distance between them means anything:
Expand Down