Skip to content

docs(api): hot_first_actions / hot_first_window + hot_only for get_actions #7

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

Merged
igorls merged 3 commits into from
Jun 3, 2026
Merged

docs(api): hot_first_actions / hot_first_window + hot_only for get_actions #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
df3eb4e
docs(api): document hot_first_actions / hot_first_window and hot_only
igorls Jun 3, 2026
a4a78a5
Potential fix for pull request finding
igorls Jun 3, 2026
9bdc776
Potential fix for pull request finding
igorls Jun 3, 2026
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
5 changes: 3 additions & 2 deletions docs/api/v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,9 @@ Get past actions based on notified account.
| after | query | Filter actions after specified date (ISO8601) | No | string |
| before | query | Filter actions before specified date (ISO8601) | No | string |
| simple | query | Simplified output mode | No | boolean |
| noBinary | query | exclude large binary data | No | boolean
| checkLib | query | perform reversibility check | No | boolean
| noBinary | query | exclude large binary data | No | boolean |
| checkLib | query | perform reversibility check | No | boolean |
| hot_only | query | Search only the newest action partition(s) instead of the full history. Useful for fetching the latest actions without fanning out across old shards | No | boolean |


!!! note
Expand Down
4 changes: 4 additions & 0 deletions docs/providers/setup/chain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ with its default value and an example of real usage.
- `"get_links": 1000`
- `"get_deltas": 1000`
- `"access_log": false` ⇒ Enable log API access.
- `"hot_first_actions": false` ⇒ When enabled, an unbounded newest-first `get_actions` account poll (e.g. `?account=eosio.token&sort=desc`, no `before`/`after`, no pagination) searches only the most recent action partition(s) first, widening to the full index set **only** if that window returns fewer than `limit` hits. Keeps high-frequency polling for the latest actions off the older/warm shards. Default off; safe to enable without reindexing. *(Note: while a poll is served from the hot window, the response `total` reflects that window only.)*
- `"hot_first_window": 2` ⇒ Number of newest action partitions searched in the hot window when `hot_first_actions` is enabled. Default `2` (covers the live partition plus the previous one across a rollover).
- `"explorer"` ⇒ Explorer configuration (see [Explorer Setup](../explorer.md))
- `"upstream": "http://127.0.0.1:4777"` ⇒ URL of the Explorer SSR server
- `"theme": "default"` ⇒ Theme name (matches `<name>.theme.mjs` in explorer/themes/)
Expand Down Expand Up @@ -159,6 +161,8 @@ to `chains/eos.config.json`. The next step is to edit the file as the following:
"get_deltas": 1000
},
"access_log": false,
"hot_first_actions": false,
"hot_first_window": 2,
"explorer": {
"upstream": "http://127.0.0.1:4777",
"theme": "default",
Expand Down