ethereum / ethereum/beacon-APIs

Validators API needs filtering

Open
#476 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
389
Forks
224
Avg merge
8h 29m
Merged PRs (30d)
3

Description

When calling `/eth/v1/beacon/states/head/validators?status=active` over 1 gigabyte of data is returned. We need to be able to get only the fields requested for various reasons. Such as only the indexes of the active validators which would reduce the size of the data returned significantly (~4 KB).

Proposal:

Allow filtering by fields, such as `/eth/v1/beacon/states/head/validators?status=active&fields=index,public_key`

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the `/eth/v1/beacon/states/head/validators` endpoint definition and review how its existing `status` query parameter is specified. Define the requested `fields=index,public_key` filtering behavior and confirm that the specification clearly describes the response for selected fields and preserves existing behavior when no fields are requested.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.